FalconryScale
DevelopersAPI reference

Add a health record

Records a health event for a raptor: an observation, treatment, vet visit, vaccination, injury, illness, medication, lab result, parasite check or moult note. Fill only the fields that apply. Attachments must be added in the app. For an ongoing medication course with dose tracking, use create_medication instead.

POST
/raptors/{raptorId}/health-records

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

A raptor's id, from list_raptors.

Lengthlength <= 64

Request Body

application/json
  1. body
recordType*string
Value in"observation""treatment""vet_visit""vaccination""injury""illness""medication""lab_result""parasite_check""moult_note"
recordDate*string

ISO 8601 date (yyyy-mm-dd).

Match^\d{4}-\d{2}-\d{2}$
symptom?string
Length1 <= length <= 500
symptomSeverity?string
Value in"mild""moderate""severe""critical"
diagnosis?string
Length1 <= length <= 1000
treatment?string
Length1 <= length <= 2000
medicationName?string
Length1 <= length <= 200
dosage?string
Length1 <= length <= 200
frequency?string
Length1 <= length <= 200
durationDays?integer
Range0 < value <= 3650
outcome?string
Value in"resolved""ongoing""worsened""unknown"
vetName?string
Length1 <= length <= 200
vetClinic?string
Length1 <= length <= 200
vetContact?string
Length1 <= length <= 200
nextAppointmentDate?string

ISO 8601 date (yyyy-mm-dd).

Match^\d{4}-\d{2}-\d{2}$
resolutionDate?string

ISO 8601 date (yyyy-mm-dd).

Match^\d{4}-\d{2}-\d{2}$
notes?string
Lengthlength <= 4000

Response Body

Add a health record

application/json
  1. response
id*string

Opaque Convex document id.

Lengthlength <= 64
raptorId*string

Opaque Convex document id.

Lengthlength <= 64
recordType*string
Value in"observation""treatment""vet_visit""vaccination""injury""illness""medication""lab_result""parasite_check""moult_note"
recordDate*string

ISO 8601 date (yyyy-mm-dd).

symptom*string|null
symptomSeverity*|null
diagnosis*string|null
treatment*string|null
medicationName*string|null
dosage*string|null
frequency*string|null
durationDays*number|null
vetName*string|null
vetClinic*string|null
vetContact*string|null
nextAppointmentDate*string|null
resolutionDate*string|null
outcome*|null
notes*string|null
attachments*array<>
loggedByName*string|null
Example Request
curl -X POST 'https://app.falconryscale.com/api/v1/raptors/string/health-records' \
  -H 'Content-Type: application/json' \
  -d '{
  "recordType": "observation",
  "recordDate": "string"
}'
Example Response
{
  "id": "string",
  "raptorId": "string",
  "recordType": "observation",
  "recordDate": "string",
  "symptom": "string",
  "symptomSeverity": "mild",
  "diagnosis": "string",
  "treatment": "string",
  "medicationName": "string",
  "dosage": "string",
  "frequency": "string",
  "durationDays": 0,
  "vetName": "string",
  "vetClinic": "string",
  "vetContact": "string",
  "nextAppointmentDate": "string",
  "resolutionDate": "string",
  "outcome": "resolved",
  "notes": "string",
  "attachments": [
    {
      "fileName": "string",
      "mimeType": "string",
      "fileSizeBytes": 0
    }
  ],
  "loggedByName": "string"
}

List a raptor’s health records

Returns one raptor’s health-care history (observations, treatments, vet visits, vaccinations, lab results, ...), most recent first. Capped at 200 rows by default (use `limit`).

Get one health record

Returns one health record by id. 404s if it does not exist or is not visible to the caller.