GET /api/v1/sequences
Each sequence carries id, name, status, publishedVersionId and its dates.
Authorization
| Role in the organization | This endpoint |
|---|---|
OWNER | Allowed |
ADMIN | Allowed |
MEMBER | Allowed |
Query parameters
| Parameter | Type | Description |
|---|---|---|
page | number | Page number, default 1 |
limit | number | Items per page, capped at 100 |
Query parameters
| Parameter | Type | Description |
|---|---|---|
status | string | active or paused |
search | string | Matches the name |
page | number | Defaults to 1 |
limit | number | Defaults to 20, capped at 100 |
Example
bash
curl -H "x-api-key: $AGENTMAIL_API_KEY" \
"https://www.agentsmail.io/api/v1/sequences?page=1&limit=20"Response
200 OK— the call succeeded.401 Unauthorized— missing or invalid key, or its owner left the organization.429 Too Many Requests— over 120 requests in a minute for this key.
Response fields
data is an array of sequences, with a pagination object next to it.
| Field | Type | Description |
|---|---|---|
success | boolean | Indicates if the operation was successful |
data[].id | string | Identifier of the sequence |
data[].name | string | Its name |
data[].status | string | active or paused |
data[].publishedVersionId | string \ | null |
data[].createdAt / updatedAt | string | ISO dates |
pagination | object | {total, page, limit, totalPages} |
Example response
json
{
"success": true,
"data": [
{
"id": "4d19c0a2",
"name": "Newsletter",
"status": "subscribed",
"publishedVersionId": "c41a7e55",
"createdAt` / `updatedAt": "value"
}
],
"pagination": {
"total": 1,
"page": 1,
"limit": 20,
"totalPages": 1
}
}