Follow-up sequences - Synthesys Docs

A follow-up sequence is an ordered set of steps that runs after a conversation. A step can wait a set time or send a message. The API is read-only for sequences. It returns only sequences attached to one of your agents.

Endpoint	Request
List follow-up sequences	GET`/v1/follow-up-sequences`
Get a follow-up sequence	GET`/v1/follow-up-sequences/{id}`

The sequence object

Sequence and step fields use camelCase.

Attributes

idstringrequired

The sequence's UUID.

namestringrequired

The sequence's name.

descriptionstring | null

A description.

agentIdstring | null

The UUID stored as the sequence's agent. Sequences can also be attached from the agent's side, so this can be null.

isActivebooleanrequired

Whether the sequence is active.

stepsarrayrequired

The sequence's steps, ordered by stepNumber. See below.

createdAtstring | null

When the sequence was created.

updatedAtstring | null

When the sequence last changed.

Step attributes

idstringrequired

The step's UUID.

sequenceIdstringrequired

The UUID of the sequence the step belongs to.

stepNumberintegerrequired

The step's position in the sequence.

actionTypestring | null

The action: sms, call, email, task or wait.

delayintegerrequired

Delay in minutes.

actionConfigobject

Settings for the action, such as instructions. Left out when not set. Keys that look like internal identifiers, such as user_id, are left out.

conditionsarray

The step's conditions. Often an empty array.

channelstring | null

The channel for the step, such as voice, sms or whatsapp. null when not set.

List follow-up sequences

GET/v1/follow-up-sequencesread key

Returns every sequence attached to one of your agents. A sequence shared by several agents appears once. This route has no pagination, so the response has no pagination object.

A sequence that can't be loaded is left out of the list instead of causing an error. If none of your agents has a sequence, data is an empty array.

Request

curl https://backend.synthesys.app/api/v1/follow-up-sequences \
  -H "SYNTH_API_KEY: YOUR_API_KEY"

Response

{
  "success": true,
  "data": [
    {
      "id": "e5f6a7b8-9c0d-4e1f-a2b3-c4d5e6f7a8b9",
      "name": "Missed call follow-up",
      "description": "Text the lead, then try again",
      "agentId": "a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
      "isActive": true,
      "steps": [
        {
          "id": "11223344-5566-4778-8990-aabbccddeeff",
          "sequenceId": "e5f6a7b8-9c0d-4e1f-a2b3-c4d5e6f7a8b9",
          "stepNumber": 1,
          "actionType": "sms",
          "delay": 30,
          "actionConfig": { "instructions": "Ask for a good time to call back." },
          "conditions": [],
          "channel": "sms"
        }
      ],
      "createdAt": "2026-09-01T10:00:00.000Z",
      "updatedAt": "2026-09-15T10:00:00.000Z"
    }
  ]
}

Get a follow-up sequence

GET/v1/follow-up-sequences/{id}read key

Returns one sequence with its steps.

Path parameters

idstringrequired

The sequence's UUID.

Returns 404 unless the sequence is attached to one of your agents and hasn't been deleted. An id that isn't a valid UUID returns 400.

Request

curl https://backend.synthesys.app/api/v1/follow-up-sequences/e5f6a7b8-9c0d-4e1f-a2b3-c4d5e6f7a8b9 \
  -H "SYNTH_API_KEY: YOUR_API_KEY"

Response

{
  "success": true,
  "data": {
    "id": "e5f6a7b8-9c0d-4e1f-a2b3-c4d5e6f7a8b9",
    "name": "Missed call follow-up",
    "description": "Text the lead, then try again",
    "agentId": "a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
    "isActive": true,
    "steps": [
      {
        "id": "11223344-5566-4778-8990-aabbccddeeff",
        "sequenceId": "e5f6a7b8-9c0d-4e1f-a2b3-c4d5e6f7a8b9",
        "stepNumber": 1,
        "actionType": "sms",
        "delay": 30,
        "actionConfig": { "instructions": "Ask for a good time to call back." },
        "conditions": [],
        "channel": "sms"
      }
    ],
    "createdAt": "2026-09-01T10:00:00.000Z",
    "updatedAt": "2026-09-15T10:00:00.000Z"
  }
}

Not found (404)

{
  "success": false,
  "error": "Follow-up sequence not found",
  "code": "NOT_FOUND",
  "requestId": "e3a1c5d7-2b4f-4a6c-9d8e-1f2a3b4c5d6e",
  "timestamp": "2026-10-31T14:02:11.482Z"
}