Get a sequence

GET /api/v1/sequences/{sequenceId} The same object, on its own. publishedVersionId is the one thing to read here: null means nothing runs, whatever the status says.

Authorization

Role in the organization	This endpoint
`OWNER`	Allowed
`ADMIN`	Allowed
`MEMBER`	Allowed

A key carries the role its creator holds in this organization — never a role on AgentsMail itself. See API keys.

Path parameters

Parameter	Type	Description
`sequenceId`	string	Required. The sequence to read

Example

bash

curl -H "x-api-key: $AGENTMAIL_API_KEY" \
  "https://www.agentsmail.io/api/v1/sequences/$SEQUENCE_ID"

Response

200 OK — the call succeeded.
401 Unauthorized — missing or invalid key, or its owner left the organization.
404 Not Found — no such resource, or it belongs to another organization. The API never confirms that an id exists to a caller who has no right to it.
429 Too Many Requests — over 120 requests in a minute for this key.

Response fields

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

Example response

json

{
  "success": true,
  "data": {
    "id": "4d19c0a2",
    "name": "Newsletter",
    "status": "subscribed",
    "publishedVersionId": "c41a7e55",
    "createdAt` / `updatedAt": "value"
  }
}