FalconryScale
DevelopersAPI reference

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.

GET
/medications/{medicationId}

Authorization

bearerAuth
headerAuthorizationBearer <token>

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

Path Parameters

medicationId*string

A medication course's id, from list_medications.

Lengthlength <= 64

Response Body

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

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.

Update a medication course

Edits a medication course, for example to change the dosage or set an end date to finish it. Only the fields you send change; null clears an optional field.