FalconryScale
DevelopersAPI reference

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.

GET
/food-items

Authorization

bearerAuth
headerAuthorizationBearer <token>

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

Query Parameters

customOnly?|

true to list only the caller's own custom items.

Response Body

List food items

application/json
  1. response
foodItems*array<>
Example Request
curl -X GET 'https://app.falconryscale.com/api/v1/food-items'
Example Response
{
  "foodItems": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "foodType": "whole",
      "defaultWeightGrams": 0,
      "isCustom": true,
      "isFavorite": true,
      "usageCount": 0,
      "lastUsedAt": "string"
    }
  ]
}

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.

Add a custom food item

Adds a custom food item to the caller's list. Names must be unique per user (case-insensitive): a duplicate answers 409 duplicate_name.