CueAPI
Get API Key

All requests below will use this key. Your API key is sent directly to api.cueapi.ai and never stored by the docs site.

GET/v1/cues

List Cues

List your cues with optional status filter and pagination.

statusstringquery

Filter by status: active, paused, completed, failed

limitintegerdefault: 20query

Maximum number of results (1-100).

offsetintegerdefault: 0query

Number of results to skip for pagination.

Request

bash
curl https://api.cueapi.ai/v1/cues \
  -H "Authorization: Bearer cue_sk_YOUR_KEY"
bash
curl "https://api.cueapi.ai/v1/cues?status=active&limit=10" \
  -H "Authorization: Bearer cue_sk_YOUR_KEY"

Response

json
{
  "cues": [
    {
      "id": "cue_a1b2c3d4e5f6",
      "name": "daily-sync",
      "status": "active",
      "next_run": "2026-03-14T09:00:00+00:00",
      "schedule": {
        "type": "recurring",
        "cron": "0 9 * * *",
        "timezone": "UTC"
      },
      "callback": {
        "url": "https://api.yourapp.com/sync",
        "method": "POST"
      },
      "transport": "webhook",
      "run_count": 42,
      "created_at": "2026-02-01T12:00:00Z"
    }
  ],
  "total": 1,
  "limit": 20,
  "offset": 0
}
GET/v1/cues
Try it
Enter your API key above to send requests
Previous← Create a CueNextGet a Cue →