GET/hyax-api/v1/sequences

List sequences

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

Query parameters

Name	Required	Description
limit	No	Page size (default 25, max 100)
offset	No	Offset (default 0)
status	No	`DRAFT` \| `ACTIVE` \| `PAUSED` \| `ARCHIVED`
search	No	Filter by name or description
archived	No	`true` to list only archived sequences

Request examples

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

curl -X GET 'https://platform.hyax.com/hyax-api/v1/sequences?limit=10&offset=0' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Example response

Shape varies by data; values are illustrative.

{
  "success": true,
  "data": [
    {
      "id": "clx…",
      "name": "Welcome series",
      "description": "Onboarding drip",
      "status": "ACTIVE",
      "archivedAt": null,
      "emailCount": 3,
      "subscriberCount": 42,
      "triggerType": "TAG_ADDED",
      "triggerTagName": "newsletter",
      "createdAt": "2025-01-15T12:00:00.000Z",
      "updatedAt": "2025-02-01T09:00:00.000Z",
      "triggers": []
    }
  ],
  "pagination": { "total": 1, "limit": 25, "offset": 0, "hasMore": false }
}