FalconryScale
DevelopersAPI reference

List the caller's alerts

Returns the caller's notifications (weight-alert triggers, reminders, ...), newest first, cursor-paginated. Pass the previous page's `nextCursor` to continue.

GET
/alerts

Authorization

bearerAuth
headerAuthorizationBearer <token>

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

Query Parameters

limit?integer

Page size. Default 20.

Range0 < value <= 100
cursor?number

Opaque pagination cursor from a previous response’s nextCursor. Omit for the first page.

Response Body

List the caller's alerts

application/json
  1. response
alerts*array<>
nextCursor*number|null
hasMore*boolean
Example Request
curl -X GET 'https://app.falconryscale.com/api/v1/alerts'
Example Response
{
  "alerts": [
    {
      "id": "string",
      "alertType": "string",
      "severity": "string",
      "title": "string",
      "message": "string",
      "actionPath": "string",
      "isRead": true,
      "createdAt": "string"
    }
  ],
  "nextCursor": 0,
  "hasMore": true
}

Revoke a pending invite

Owner or admin only. Cancels a pending team invite so its link stops working and the seat frees up. Cannot be undone (send a new invite instead), so confirm which invite with the user first. Counts toward the same 5 per hour / 20 per day limit as invites (429 when exceeded).

Mark an alert read

Marks one of the caller’s alerts as read. Already-read alerts are left as they are.