FalconryScale
DevelopersAPI reference

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.

POST
/food-items

Authorization

bearerAuth
headerAuthorizationBearer <token>

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

Request Body

application/json
  1. body
name*string
Match^[\p{L}\p{M}\p{N} '_-]+$
Length2 <= length <= 50
description?string
Lengthlength <= 500
foodType?string
Value in"whole""portion"
defaultWeightGrams?number

Typical portion weight, grams. Pre-fills the amount when logging.

Range0 < value <= 20000

Response Body

Add a custom food item

application/json
  1. response
id*string

Opaque Convex document id.

Lengthlength <= 64
name*string

Display name, e.g. "Quail".

description*string|null
foodType*|

'whole' (a whole animal) or 'portion' (a cut or part).

defaultWeightGrams*number|null
isCustom*boolean

True for an item the caller created (editable); false for a built-in item.

isFavorite*boolean
usageCount*number
lastUsedAt*string|null
Example Request
curl -X POST 'https://app.falconryscale.com/api/v1/food-items' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string"
}'
Example Response
{
  "id": "string",
  "name": "string",
  "description": "string",
  "foodType": "whole",
  "defaultWeightGrams": 0,
  "isCustom": true,
  "isFavorite": true,
  "usageCount": 0,
  "lastUsedAt": "string"
}

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.

Edit a custom food item

Edits one of the caller's own custom food items (built-in items can't be edited: 404). Only the fields you send change; null clears an optional field.