FalconryScale
DevelopersAPI reference

Log a feeding

Records a feeding activity for a raptor on the caller's behalf. For a scale reading of the amount fed, use log_weight with stomachState 'fed' instead.

POST
/raptors/{raptorId}/feedings

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

Request Body

application/json
  1. body
activityDate*string

ISO 8601 date (yyyy-mm-dd).

Lengthlength <= 32
preyCount?integer
Range0 <= value <= 9007199254740991
locationDescription?string
Lengthlength <= 500
notes?string
Lengthlength <= 2000

Response Body

Log a feeding

application/json
  1. response
id*string

Opaque Convex document id.

Lengthlength <= 64
activityType*string
Value in"training""hunting""feeding""flight_exercise""health_observation""transport"
activityDate*string

ISO 8601 date (yyyy-mm-dd).

startTime*|

HH:MM time of day.

durationMinutes*number|null
locationDescription*string|null
preFlightWeightGrams*number|null
postFlightWeightGrams*number|null
weightChangeGrams*number|null
preyCount*number|null
successOutcome*|

Whether a hunting slip was successful.

activitySubtype*string|null
behavioralTags*array<string>
creanceLengthM*|

Training: creance line length, metres.

recallDistanceM*|

Training: recall distance, metres.

slipAssessment*|

Hunting only: the slip assessment (each advantage 0 to 100), when one was recorded.

notes*string|null
loggedByName*string|null
Example Request
curl -X POST 'https://app.falconryscale.com/api/v1/raptors/string/feedings' \
  -H 'Content-Type: application/json' \
  -d '{
  "activityDate": "string"
}'
Example Response
{
  "id": "string",
  "activityType": "training",
  "activityDate": "string",
  "startTime": "string",
  "durationMinutes": 0,
  "locationDescription": "string",
  "preFlightWeightGrams": 0,
  "postFlightWeightGrams": 0,
  "weightChangeGrams": 0,
  "preyCount": 0,
  "successOutcome": true,
  "activitySubtype": "string",
  "behavioralTags": [
    "string"
  ],
  "creanceLengthM": 0,
  "recallDistanceM": 0,
  "slipAssessment": {
    "heightAdvantage": 0,
    "speedAdvantage": 0,
    "proximityAdvantage": 0,
    "surpriseAdvantage": 0,
    "coverAdvantage": 0,
    "preyEscapeMethod": "outran",
    "birdUsedHeightEffectively": true
  },
  "notes": "string",
  "loggedByName": "string"
}

Delete an activity

Deletes one activity (feeding, training, hunt, ...). It disappears from every list and cannot be restored from this API. Before calling, read the activity back to the user (type, date and raptor) and get their explicit confirmation.

List food items

Returns the food items the caller can log (built-in ones plus their own custom items), with the caller's favourite flag and usage count. Use an item's `id` as `preyTypeId` in log_weight / update_weight for a fed weigh-in.