FalconryScale
DevelopersAPI reference

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.

PATCH
/profile

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
firstName?string
Length1 <= length <= 100
lastName?string
Length1 <= length <= 100
fullName?string
Length1 <= length <= 200
bio?|null
location?|null
preferredUnits?string

Weight display unit: 'metric' (grams), 'imperial' (ounces) or 'pounds'. Display only: this API always uses grams.

Value in"metric""imperial""pounds"
weightPrecision?|

0 = whole grams, 1 = one decimal place.

distanceTemperatureUnit?string
Value in"metric""imperial"
dateFormat?string
Value in"d MMM yyyy""dd/MM/yyyy""MM/dd/yyyy""yyyy-MM-dd"
preferredLanguage?string
Value in"en""it""es""ar"
falconrySince?|null
yearsExperience?|null
userExperienceLevel?|null

Response Body

Update the caller's profile

application/json
  1. response
id*string

Opaque Convex document id.

Lengthlength <= 64
email*string
firstName*string|null
lastName*string|null
fullName*string|null
bio*string|null
location*string|null
avatarUrl*string|null
preferredUnits*|

'metric' or 'imperial', for display only. Weights from this API are always grams.

weightPrecision*|

Decimal places the user prefers weights displayed with.

distanceTemperatureUnit*string|null
dateFormat*string|null
subscriptionTier*string
Value in"free""pro""team"
onboardingCompleted*boolean
falconrySince*|

A 4-digit year, e.g. 2019.

preferredLanguage*string|null
userExperienceLevel*string|null
yearsExperience*number|null
Example Request
curl -X PATCH 'https://app.falconryscale.com/api/v1/profile' \
  -H 'Content-Type: application/json' \
  -d '{}'
Example Response
{
  "id": "string",
  "email": "string",
  "firstName": "string",
  "lastName": "string",
  "fullName": "string",
  "bio": "string",
  "location": "string",
  "avatarUrl": "string",
  "preferredUnits": "string",
  "weightPrecision": 0,
  "distanceTemperatureUnit": "string",
  "dateFormat": "string",
  "subscriptionTier": "free",
  "onboardingCompleted": true,
  "falconrySince": 0,
  "preferredLanguage": "string",
  "userExperienceLevel": "string",
  "yearsExperience": 0
}

Get the caller's profile

Returns the signed-in caller's own Falconry Scale profile: name, bio, display preferences, and subscription tier. Call this first to learn who the caller is before any raptor-scoped call.

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.