Your 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/{cue_id}

Get Cue

Get detailed information about a cue, including recent executions.

cue_idstringrequiredpath

The cue ID (format: cue_xxxxxxxxxxxx).

Request

bash

curl https://api.cueapi.ai/v1/cues/cue_a1b2c3d4e5f6 \
  -H "Authorization: Bearer cue_sk_YOUR_KEY"

Response

json

{
  "id": "cue_a1b2c3d4e5f6",
  "name": "daily-sync",
  "status": "active",
  "next_run": "2026-03-14T09:00:00+00:00",
  "last_run": "2026-03-13T09:00:02Z",
  "schedule": {
    "type": "recurring",
    "cron": "0 9 * * *",
    "timezone": "UTC"
  },
  "callback": {
    "url": "https://api.yourapp.com/sync",
    "method": "POST"
  },
  "transport": "webhook",
  "payload": {"task": "sync-inventory"},
  "run_count": 42,
  "created_at": "2026-02-01T12:00:00Z",
  "executions": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "status": "success",
      "scheduled_for": "2026-03-13T09:00:00Z",
      "attempts": 1,
      "http_status": 200,
      "started_at": "2026-03-13T09:00:01Z",
      "delivered_at": "2026-03-13T09:00:02Z",
      "outcome": {
        "success": true,
        "result": "Synced 142 records",
        "recorded_at": "2026-03-13T09:00:03Z"
      }
    }
  ]
}

json

{
  "error": {
    "code": "cue_not_found",
    "message": "Cue not found: cue_abc123def456",
    "status": 404
  }
}

GET/v1/cues/{cue_id}

Try it

Replace path parameters (e.g. {cue_id}) in the URL before sending.

Enter your API key above to send requests

Previous← List Cues NextUpdate a Cue →