FalconryScale
DevelopersAPI reference

Get today's roster checklist

A single-call morning overview: how many raptors the caller has, which have already been weighed today, which still need weighing, and the caller's unread alert count. Prefer this over separate list_raptors + get_latest_weights + list_alerts calls when all you need is the checklist.

GET
/today

Authorization

bearerAuth
headerAuthorizationBearer <token>

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

Response Body

Get today's roster checklist

application/json
  1. response
date*string

Today's UTC calendar date, ISO 8601 (yyyy-mm-dd): the server has no per-user timezone to use instead.

raptorCount*integer
Range-9007199254740991 <= value <= 9007199254740991
weighedInToday*array<>

Raptor ids whose most recent weigh-in falls on date.

needsWeighIn*array<>

Raptor ids NOT yet weighed on date (includes a raptor with no weigh-ins at all).

unreadAlertCount*integer
Range-9007199254740991 <= value <= 9007199254740991
Example Request
curl -X GET 'https://app.falconryscale.com/api/v1/today'
Example Response
{
  "date": "string",
  "raptorCount": -9007199254740991,
  "weighedInToday": [
    "string"
  ],
  "needsWeighIn": [
    "string"
  ],
  "unreadAlertCount": -9007199254740991
}

Update the caller's profile

Edits the caller's own profile: name, bio, location, display preferences (units, precision, date format, language) and falconry experience. Only the fields you send change; null clears an optional field. Email, plan and photos can't be changed here.

Get notification preferences

Returns the caller's notification switches: each push toggle, its matching `_email` toggle, the push master switch, and the evening digest time (UTC). Unset switches show the app's default.