FalconryScale
DevelopersAPI reference

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

Opaque Convex document id.

Lengthlength <= 64

Query Parameters

limit?integer

Cap the number of rows returned, most recent first. Default and max 200.

Range0 < value <= 200

Response Body

List a raptor’s health records

application/json
  1. response
healthRecords*array<>
Example Request
curl -X GET 'https://app.falconryscale.com/api/v1/raptors/string/health-records'
Example Response
{
  "healthRecords": [
    {
      "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"
    }
  ]
}