Sequences

Returns matching automation sequences, newest first. Omit limit and offset to return all matches; either parameter enables pagination (default page size 50, capped at 100).

get/sequences

Request

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/sequences
  • Auth
    HTTP bearer

Query parameters

status'draft' | 'active' | 'paused' | 'archived'

Stored lifecycle status. Do not read literally: a sequence can be active while enrollmentPaused blocks new subscribers. Branch on effectiveStatus instead.

searchstring

Case-insensitive name or description search.

labelsstring

Comma-separated dashboard label names. The label alias is also accepted.

limitinteger

Page size, up to 100. When limit and offset are both omitted, every sequence is returned.

offsetinteger
labelstring

Alias for labels. Takes precedence if both are present.

Response

Sequences retrieved successfully

successboolean

Example response

{
  "success": true,
  "sequences": [
    {
      "id": "seq_abc123",
      "name": "Welcome Sequence",
      "trigger": "trigger_list",
      "sendingWindow": {
        "enabled": true,
        "timezone": "Europe/Kiev",
        "startTime": "08:00",
        "endTime": "20:00",
        "days": [
          "monday",
          "tuesday",
          "wednesday",
          "thursday",
          "friday"
        ]
      },
      "frequencyCapEnabled": true,
      "keyDates": {
        "timezone": "America/New_York",
        "dates": [
          {
            "key": "black_friday_starts",
            "label": "Black Friday starts",
            "at": "2026-11-27T05:00:00.000Z"
          }
        ]
      },
      "audienceAutoEnroll": {
        "enabled": true,
        "audience": {
          "type": "lists",
          "listIds": [
            "list_abc123"
          ],
          "segmentId": "seg_abc123",
          "includedSubscriberIds": [
            "sub_abc123",
            "sub_def456"
          ]
        }
      },
      "bccEmails": [
        "cs-team@example.com"
      ]
    }
  ]
}

Changes

    • info

      added the optional property // to the response with the status

    • info

      added the optional property ///////// to the response with the status