FalconryScale
DevelopersAPI reference

List documents

Lists the caller's documents (permits, CITES papers, vet records, insurance, ...) as metadata: title, type, dates, issuing authority and file name/size, newest first. No file contents or download links. Pass `expiringWithinDays` for the renewals view, soonest expiry first.

GET
/documents

Authorization

bearerAuth
headerAuthorizationBearer <token>

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

Query Parameters

raptorId?string

Only this raptor's documents. Omit for every document the caller can see.

Lengthlength <= 64
expiringWithinDays?integer

Only documents that have not expired yet and expire within this many days, soonest first (e.g. 30 for "what needs renewing this month").

Range0 <= value <= 365
limit?integer

Max rows. Default and max 200.

Range0 < value <= 200

Response Body

List documents

application/json
  1. response
documents*array<>
Example Request
curl -X GET 'https://app.falconryscale.com/api/v1/documents'
Example Response
{
  "documents": [
    {
      "id": "string",
      "raptorId": "string",
      "documentType": "legal_permit",
      "title": "string",
      "description": "string",
      "fileName": "string",
      "mimeType": "string",
      "fileSizeBytes": 0,
      "issueDate": "string",
      "expiryDate": "string",
      "issuingAuthority": "string",
      "tags": [
        "string"
      ],
      "reminderOffsets": [
        0
      ],
      "daysUntilExpiry": 0,
      "createdAt": "string",
      "loggedByName": "string"
    }
  ]
}

Log a medication dose

Records whether one day's dose was taken, missed or skipped. Logging the same date again replaces that day's entry. Returns the course with its updated dose log.

Get one document’s details

Returns one document's metadata by id (no file contents or link). 404s if it does not exist or is not visible to the caller.