Sequences

Get Sequence Mailboxes

The sequence's mailbox rotation pool (RO-271): `mode` `pool` (only `mailbox_ids` start new conversations) or `all` (every mailbox), with each live mailbox of the workspace and whether it sends for this sequence.

API key access

Needs the sequences:read scope with an API key (ro_pat_...). A signed-in session uses the caller's role.
GET/api/v1/sequences/{sequence_id}/mailboxes
AuthorizationBearer <token>

Access token from /api/v1/auth/login, or an API key (ro_pat_..., RO-176) from /api/v1/workspaces/current/api-keys: the key implies its workspace and needs the route's scope. MCP connectors (/api/v1/mcp only) may use an OAuth access token (ro_oat_..., RO-284).

In: header

Path Parameters

sequence_idstring
Formatuuid

Header Parameters

X-Workspace-Id?string | null

Id of the workspace to act on (must be a member).

Response Body

curl -X GET "http://localhost:8000/api/v1/sequences/497f6eca-6276-4993-bfeb-53cbbbba6f08/mailboxes" \  -H "X-Workspace-Id: string"
{
  "sequence_id": "7cd84c09-94f4-486c-9c49-de3b9cf3f74f",
  "mode": "pool",
  "mailbox_ids": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "mailboxes": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "email_address": "string",
      "status": "string",
      "paused": true,
      "rotation_weight": 0,
      "in_pool": true,
      "sends": true
    }
  ]
}
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}