> ## Documentation Index
> Fetch the complete documentation index at: https://docs.theomnibot.io/llms.txt
> Use this file to discover all available pages before exploring further.

# List All Message Sequences via the ChatbotX REST API

> Retrieve a paginated list of all message sequences in your ChatbotX workspace, including subscriber counts and engagement metrics.

Sequences are timed, multi-step message campaigns that nurture your contacts over time. Use this endpoint to list all sequences in your workspace. The response includes engagement metrics such as open rate and click-through rate alongside subscriber and step counts for each sequence.

<Info>
  **GET** `/api/v1/sequences`
</Info>

## Query Parameters

<ParamField query="page" type="integer">
  The page number to retrieve. Must be `1` or greater.
</ParamField>

<ParamField query="perPage" type="integer">
  Number of sequences to return per page. Must be `1` or greater.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl --request GET \
    --url 'https://app.chatbotx.io/api/v1/sequences?page=1&perPage=20' \
    --header 'Authorization: Bearer <token>'
  ```

  ```python Python theme={null}
  import requests

  url = "https://app.chatbotx.io/api/v1/sequences"

  params = {"page": 1, "perPage": 20}
  headers = {"Authorization": "Bearer <token>"}

  response = requests.get(url, params=params, headers=headers)
  print(response.json())
  ```

  ```javascript JavaScript theme={null}
  const options = {
    method: 'GET',
    headers: { Authorization: 'Bearer <token>' }
  };

  fetch('https://app.chatbotx.io/api/v1/sequences?page=1&perPage=20', options)
    .then(res => res.json())
    .then(res => console.log(res))
    .catch(err => console.error(err));
  ```
</CodeGroup>

## Response

Returns `200 OK` with a `data` array of sequence objects and a `pageCount` for pagination.

### Response Fields

<ResponseField name="data" type="array" required>
  Array of sequence objects.

  <Expandable title="data item fields">
    <ResponseField name="id" type="string" required>
      Unique identifier for the sequence.
    </ResponseField>

    <ResponseField name="name" type="string" required>
      Display name of the sequence.
    </ResponseField>

    <ResponseField name="active" type="boolean" required>
      Whether the sequence is currently active and enrolling new subscribers.
    </ResponseField>

    <ResponseField name="stepsCount" type="integer" required>
      The total number of steps (messages) in the sequence.
    </ResponseField>

    <ResponseField name="subscribersCount" type="integer" required>
      The total number of contacts currently subscribed to the sequence.
    </ResponseField>

    <ResponseField name="subscribers" type="integer" required>
      Total subscribers who have entered the sequence.
    </ResponseField>

    <ResponseField name="messages" type="integer" required>
      Total messages sent across all steps of the sequence.
    </ResponseField>

    <ResponseField name="openRate" type="number | null" required>
      The message open rate as a decimal (e.g., `0.45` for 45%).
    </ResponseField>

    <ResponseField name="ctr" type="number | null" required>
      The click-through rate as a decimal (e.g., `0.12` for 12%).
    </ResponseField>

    <ResponseField name="folderId" type="string | null" required>
      The folder this sequence is organised into, or `null`.
    </ResponseField>

    <ResponseField name="workspaceId" type="string" required>
      The workspace this sequence belongs to.
    </ResponseField>

    <ResponseField name="createdAt" type="string" required>
      ISO 8601 timestamp for when the sequence was created.
    </ResponseField>

    <ResponseField name="updatedAt" type="string" required>
      ISO 8601 timestamp for when the sequence was last updated.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="pageCount" type="number" required>
  The total number of pages available based on the current `perPage` value.
</ResponseField>

### Example Response

```json theme={null}
{
  "data": [
    {
      "id": "seq_001",
      "name": "7-Day Onboarding",
      "active": true,
      "stepsCount": 7,
      "subscribersCount": 1240,
      "subscribers": 1350,
      "messages": 8450,
      "openRate": 0.61,
      "ctr": 0.18,
      "folderId": null,
      "workspaceId": "42",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2024-01-15T10:22:00Z"
    }
  ],
  "pageCount": 3
}
```