FalconryScale
DevelopersAPI reference

Star or unstar a raptor

Marks a raptor as a favourite (isFavorite true) or removes the star (false). Returns the updated raptor.

POST
/raptors/{raptorId}/favorite

Authorization

bearerAuth
headerAuthorizationBearer <token>

A Clerk user API key or OAuth access token carrying the falconry:read and/or falconry:write scope.

Path Parameters

raptorId*string

A raptor's id, from list_raptors.

Lengthlength <= 64

Request Body

application/json
  1. body
isFavorite*boolean

Response Body

Star or unstar a raptor

application/json
  1. response
id*string

Opaque Convex document id.

Lengthlength <= 64
name*string
species*|null
gender*|null
status*|null
acquisitionDate*string

ISO 8601 date (yyyy-mm-dd).

birthDate*|

ISO 8601 date (yyyy-mm-dd), the hatch date.

bandNumber*string|null
microchipId*string|null
notes*string|null
avatarUrl*string|null
headerUrl*string|null
targetWeightMinGrams*number|null
targetWeightMaxGrams*number|null
readyWeightGrams*number|null
toleranceGrams*number|null
latestWeightGrams*|

The raptor's most recent logged weigh-in, grams.

isFavorite*boolean
isInMoult*boolean
moultStartedAt*|

ISO 8601 datetime the current moult started, when in moult.

moultTargetWeightGrams*number|null
acquisitionMethod*|null
fate*|null
fateNote*string|null
transmitterFrequencyMhz*number|null
isTeamShared*boolean

Whether the bird is shared with its owner's team.

ownerName*|

The owner's display name, for a team-shared bird the caller does not own.

canLog*boolean

Whether the caller may log weigh-ins, feedings and activities on this bird.

canEdit*boolean

Whether the caller may edit the bird's details and plans.

isOwn*boolean|null
myRole*|

'self' when the caller owns the bird, else their team role on it.

Example Request
curl -X POST 'https://app.falconryscale.com/api/v1/raptors/string/favorite' \
  -H 'Content-Type: application/json' \
  -d '{
  "isFavorite": true
}'
Example Response
{
  "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 a raptor’s weight-alert thresholds

Changes the weight-alert thresholds. Only the fields you send change; null turns a threshold off. Needs edit rights on the bird.

Change a raptor's status

Moves a raptor through its lifecycle: active, sold, deceased, released, or archived (archive hides it from the active roster without deleting anything). Can be reversed by setting 'active' again, which fails with 409 quota_exceeded when the bird's owner is on the free plan and already has 3 active birds. Confirm with the user before marking a bird sold, deceased or released.