FalconryScale
DevelopersAPI reference

Get a raptor’s weight-alert thresholds

Returns the thresholds that raise a weight alert for this raptor: a rapid-drop percent and a min/max weight in grams.

GET
/raptors/{raptorId}/weight-alert-settings

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

Response Body

Get a raptor’s weight-alert thresholds

application/json
  1. response
alertsEnabled*boolean
rapidDropPercent*|

Alert when weight drops by more than this percent in 24 hours. null = off.

alertWeightMinGrams*|

Alert below this weight, grams. null = off.

alertWeightMaxGrams*|

Alert above this weight, grams. null = off.

Example Request
curl -X GET 'https://app.falconryscale.com/api/v1/raptors/string/weight-alert-settings'
Example Response
{
  "alertsEnabled": true,
  "rapidDropPercent": 0,
  "alertWeightMinGrams": 0,
  "alertWeightMaxGrams": 0
}

List a raptor’s past moults

Returns a raptor's finished moults, most recent first, with start/end dates (ISO 8601) and end weight in grams.

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.