FalconryScale
DevelopersAPI reference

Get a raptor’s weigh-in history

Returns one raptor's logged weigh-ins, newest first, in grams. Use `since` to bound a date range and `limit` to cap the count (default and max 500). A free-tier account's history beyond 30 days reads as empty (the app's own retention rule), not an error.

GET
/raptors/{raptorId}/weights

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

Opaque Convex document id.

Lengthlength <= 64

Query Parameters

since?string

ISO 8601 datetime: only weigh-ins measured at or after this instant.

Lengthlength <= 40
limit?integer

Cap the number of rows returned, newest first. Default 500 (the max).

Range0 < value <= 500

Response Body

Get a raptor’s weigh-in history

application/json
  1. response
weights*array<>
Example Request
curl -X GET 'https://app.falconryscale.com/api/v1/raptors/string/weights'
Example Response
{
  "weights": [
    {
      "id": "string",
      "weightGrams": 0,
      "measuredAt": "string",
      "stomachState": "empty",
      "avgGph": 0,
      "notes": "string",
      "preyTypeId": "string",
      "raptorId": "string",
      "preyAmountGrams": 0,
      "loggedByName": "string"
    }
  ]
}

Share a raptor with the team, or make it private

Owner only. shared true shares the bird with the caller's team (every member then sees it, and members can log on it); false makes it private again and cuts off teammates' access. Confirm with the user before changing who can see a bird.

Log a weigh-in

Records a new weigh-in for a raptor, in grams. This is how an AI assistant logs a scale reading on the caller's behalf.