FalconryScale
DevelopersAPI reference

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.

GET
/documents/{documentId}

Authorization

bearerAuth
headerAuthorizationBearer <token>

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

Path Parameters

documentId*string

A document's id, from list_documents.

Lengthlength <= 64

Response Body

Get one document’s details

application/json
  1. response
id*string

Opaque Convex document id.

Lengthlength <= 64
raptorId*|

The raptor this document belongs to, or null for an account-level document.

documentType*string
Value in"legal_permit""cites""vet_record""breeding_record""sales_contract""insurance""image""training_certificate""other""microchip"
title*string
description*string|null
fileName*string
mimeType*string
fileSizeBytes*number
issueDate*string|null
expiryDate*string|null
issuingAuthority*string|null
tags*array<string>
reminderOffsets*array<number>

Days before expiry to send a reminder, e.g. [30, 7, 1].

daysUntilExpiry*|

Whole days from today (UTC) to expiryDate; negative once expired.

createdAt*string
loggedByName*string|null
Example Request
curl -X GET 'https://app.falconryscale.com/api/v1/documents/string'
Example Response
{
  "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"
}

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.

Update a document’s details

Edits a document's details (title, dates, issuing authority, tags, expiry reminders, which raptor it belongs to). The file itself can't be changed through the API. Only the fields you send change; null clears an optional field.