List the caller's raptors
Returns the caller's roster of raptors (birds), newest-added first. Each one carries its current target/ready weight and most recent weigh-in in grams. Use `get_raptor` for the full detail of one, or follow up with get_weight_history/list_activities/list_health_records using the returned `id`.
bearerAuthAuthorizationBearer <token>A Clerk user API key or OAuth access token carrying the falconry:read and/or falconry:write scope.
scope?string'all' (default): own birds + team-shared birds. 'mine': own only. 'team': every bird shared with the caller's team.
"all""mine""team"List the caller's raptors
application/json- response
raptors*array<>curl -X GET 'https://app.falconryscale.com/api/v1/raptors'{
"raptors": [
{
"id": "string",
"name": "string",
"species": {
"id": "string",
"commonName": "string",
"scientificName": "string",
"photoUrl": "string"
},
"gender": "male",
"status": "active",
"acquisitionDate": "string",
"birthDate": "string",
"bandNumber": "string",
"microchipId": "string",
"notes": "string",
"avatarUrl": "string",
"headerUrl": "string",
"targetWeightMinGrams": 0,
"targetWeightMaxGrams": 0,
"readyWeightGrams": 0,
"toleranceGrams": 0,
"latestWeightGrams": 0,
"isFavorite": true,
"isInMoult": true,
"moultStartedAt": "string",
"moultTargetWeightGrams": 0,
"acquisitionMethod": "bred",
"fate": "active",
"fateNote": "string",
"transmitterFrequencyMhz": 0,
"isTeamShared": true,
"ownerName": "string",
"canLog": true,
"canEdit": true,
"isOwn": true,
"myRole": "self"
}
]
}Update notification preferences
Turns individual notification switches on or off, or changes the evening digest time (HH:MM, UTC). Only the keys you send change. Returns the full, updated preferences.
Add a raptor
Adds a new bird to the caller's roster. Look up `speciesId` with search_species first. A free-tier account is capped at 3 active raptors: past the cap this answers 409 quota_exceeded, and the caller has to upgrade in the app. Confirm the name and species with the user before calling.