FalconryScale
DevelopersAPI reference

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
/profile

Authorization

bearerAuth
headerAuthorizationBearer <token>

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

Response Body

Get 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 GET 'https://app.falconryscale.com/api/v1/profile'
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
}