FalconryScale
DevelopersAPI reference

Start a medication course

Adds a medication course for a raptor (name, dosage, frequency, start and optional end date, optional daily reminder). Log each day’s dose with log_medication_dose.

POST
/raptors/{raptorId}/medications

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
name*string
Length1 <= length <= 200
dosage?string

e.g. "0.1 ml". Defaults to empty.

Lengthlength <= 200
frequency?string

e.g. "twice daily". Defaults to empty.

Lengthlength <= 200
startDate*string

ISO 8601 date (yyyy-mm-dd).

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

Omit for an open-ended course.

Match^\d{4}-\d{2}-\d{2}$
reminderEnabled?boolean
reminderTime?string

24-hour time of day, HH:MM.

Match^([01]\d|2[0-3]):[0-5]\d$
linkedHealthRecordId?string

A health record of the same raptor this course belongs to.

Lengthlength <= 64
notes?string
Lengthlength <= 2000

Response Body

Start a medication course

application/json
  1. response
id*string

Opaque Convex document id.

Lengthlength <= 64
raptorId*string

Opaque Convex document id.

Lengthlength <= 64
name*string
dosage*string
frequency*string
startDate*string

ISO 8601 date (yyyy-mm-dd).

endDate*|

ISO 8601 date, or null for an open-ended course.

reminderEnabled*boolean
reminderTime*|

Daily reminder time, HH:MM (24-hour).

linkedHealthRecordId*|null
notes*string|null
doseLog*array<>

Logged doses, one per day, newest first (at most the last 60).

loggedByName*string|null
Example Request
curl -X POST 'https://app.falconryscale.com/api/v1/raptors/string/medications' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "startDate": "string"
}'
Example Response
{
  "id": "string",
  "raptorId": "string",
  "name": "string",
  "dosage": "string",
  "frequency": "string",
  "startDate": "string",
  "endDate": "string",
  "reminderEnabled": true,
  "reminderTime": "string",
  "linkedHealthRecordId": "string",
  "notes": "string",
  "doseLog": [
    {
      "date": "string",
      "status": "taken",
      "loggedAt": "string"
    }
  ],
  "loggedByName": "string"
}

List a raptor’s medication courses

Returns one raptor’s medication courses (active and past), most recently started first. Capped at 200 rows by default (use `limit`).

Get one medication course

Returns one medication course by id, with its dose log. 404s if it does not exist or is not visible to the caller.