← Documentation home
GET/hyax-api/v1/sequences/:id

Get sequence

Returns sequence metadata, triggers, exit triggers, and ordered email steps (without full HTML bodies).

Base URL: https://platform.hyax.com · Replace YOUR_API_KEY with your team API key.

Request examples

Same request in cURL, Node.js (fetch), and PHP (ext-curl).

curl -X GET 'https://platform.hyax.com/hyax-api/v1/sequences/clx_example_id' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Example response

Shape varies by data; values are illustrative.

{
  "success": true,
  "data": {
    "id": "clx…",
    "name": "Welcome series",
    "status": "ACTIVE",
    "emailCount": 2,
    "emails": [
      {
        "id": "clx_email…",
        "subject": "Welcome!",
        "order": 0,
        "delayDays": 0,
        "delayHours": 0,
        "status": "ACTIVE",
        "preheader": null
      }
    ],
    "triggers": [],
    "exitTriggers": []
  }
}