FalconryScale
DevelopersAPI reference

Get a raptor’s active bring-down plan

Returns the raptor's active bring-down plan (bringing the bird from its start weight down to its ready weight safely, at most 1.5% a day): today's day number, the total days, and the target weight for every day, in grams. `plan` is null when none is running.

GET
/raptors/{raptorId}/bring-down-plan

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 active bring-down plan

application/json
  1. response
plan*|null
Example Request
curl -X GET 'https://app.falconryscale.com/api/v1/raptors/string/bring-down-plan'
Example Response
{
  "plan": {
    "scheduleId": "string",
    "startWeightGrams": 0,
    "startDate": "string",
    "targetWeightGrams": 0,
    "dayNumber": -9007199254740991,
    "totalDays": -9007199254740991,
    "dailyTargets": [
      {
        "day": -9007199254740991,
        "date": "string",
        "targetWeightGrams": 0
      }
    ]
  }
}