List sequences

GET/v1/sequences

Returns a paginated list of sequences, including ones that have never been published. Results are sorted by when the sequence was created (createdAt), newest first. Use offset and limit to paginate through results, and bracketed filters to narrow the list. See List endpoints for more information about pagination.

Supported filters: status[equal] (DRAFT, ACTIVE, DEACTIVATED), channels[contains] (EMAIL, LINKEDIN), and createdAt, firstActivatedAt or lastActivatedAt with [greaterThanOrEqual] or [lessThanOrEqual] (ISO 8601 timestamps with a timezone). Filters are combined with AND.

Required scope: sequences:read

Rate limit category: Search

ParametersExpand Collapse

limit: Optional[int]

Maximum number of records to return. Defaults to 25, maximum 25.

minimum1

maximum9007199254740991

offset: Optional[int]

Number of records to skip for pagination. Defaults to 0.

minimum0

maximum9007199254740991

ReturnsExpand Collapse

class SequenceListResponse: …

data: List[Data]

id: str

Unique identifier of the sequence.

channels: List[Literal["EMAIL", "LINKEDIN"]]

Channels the published steps send on; empty before the first publish.

One of the following:

"EMAIL"

"LINKEDIN"

created_at: str

ISO 8601 creation timestamp.

definition: Optional[DataDefinition]

Published configuration, or null before the first publish.

description: str

What this version of the sequence is for.

messaging: DataDefinitionMessaging

Messaging inputs that frame every step.

call_to_action: Optional[str]

What the recipient is asked to do.

persona: Optional[str]

Who the sequence targets.

trigger: Optional[str]

Why the outreach is timely.

value_prop: Optional[str]

The value proposition.

pacing: DataDefinitionPacing

How the whole sequence paces each step type it sends, keyed by sequence step type.

email: DataDefinitionPacingEmail

Email steps.

daily_limit: Optional[int]

Most sends of this step type across the whole sequence in any rolling 24 hours, or null when the sequence sets no daily cap. Workspace and sender limits still apply.

minimum-9007199254740991

maximum9007199254740991

linkedin_invite: DataDefinitionPacingLinkedinInvite

LinkedIn connection requests.

daily_limit: Optional[int]

Most sends of this step type across the whole sequence in any rolling 24 hours, or null when the sequence sets no daily cap. Workspace and sender limits still apply.

minimum-9007199254740991

maximum9007199254740991

linkedin_message: DataDefinitionPacingLinkedinMessage

LinkedIn messages.

daily_limit: Optional[int]

Most sends of this step type across the whole sequence in any rolling 24 hours, or null when the sequence sets no daily cap. Workspace and sender limits still apply.

minimum-9007199254740991

maximum9007199254740991

priority: Literal["HIGH", "NORMAL"]

Send priority relative to other sequences.

One of the following:

"HIGH"

"NORMAL"

send_window: DataDefinitionSendWindow

When the sequence may send.

days_of_week: List[int]

Days sends may go out, 0 = Sunday.

end_hour: int

Local hour sends stop, exclusive (1–24).

minimum-9007199254740991

maximum9007199254740991

start_hour: int

First local hour sends may go out (0–23).

minimum-9007199254740991

maximum9007199254740991

timezone: str

IANA timezone of the window.

steps: List[DataDefinitionStep]

Email, LinkedIn and wait steps in execution order.

One of the following:

class DataDefinitionStepUnionMember0: …

id: str

Step identifier, referenced by enrollment currentStepId and message sequenceStepId.

delivery_mode: Literal["AUTO", "FOR_REVIEW"]

AUTO sends without manual approval, subject to the send window and limits; FOR_REVIEW requires a person to approve the draft before sending.

One of the following:

"AUTO"

"FOR_REVIEW"

mode: Literal["AGENT"]

How each message is written: AGENT composes it from prompt; TEMPLATE sends template to every contact, with its variables filled in.

Display name of the step.

prompt: str

Instructions the agent follows when composing this message.

type: Literal["EMAIL", "LINKEDIN_MESSAGE"]

Step type.

One of the following:

"EMAIL"

"LINKEDIN_MESSAGE"

class DataDefinitionStepUnionMember1: …

id: str

Step identifier, referenced by enrollment currentStepId and message sequenceStepId.

delivery_mode: Literal["AUTO", "FOR_REVIEW"]

AUTO sends without manual approval, subject to the send window and limits; FOR_REVIEW requires a person to approve the draft before sending.

One of the following:

"AUTO"

"FOR_REVIEW"

include_note: bool

Whether the connection request carries a note. A step authored before this setting existed reads as true.

mode: Literal["AGENT"]

How each message is written: AGENT composes it from prompt; TEMPLATE sends template to every contact, with its variables filled in.

Display name of the step.

prompt: str

Instructions the agent follows when composing this message.

type: Literal["LINKEDIN_INVITE"]

Step type.

class DataDefinitionStepUnionMember2: …

id: str

Step identifier, referenced by enrollment currentStepId and message sequenceStepId.

delivery_mode: Literal["AUTO", "FOR_REVIEW"]

AUTO sends without manual approval, subject to the send window and limits; FOR_REVIEW requires a person to approve the draft before sending.

One of the following:

"AUTO"

"FOR_REVIEW"

mode: Literal["TEMPLATE"]

How each message is written: AGENT composes it from prompt; TEMPLATE sends template to every contact, with its variables filled in.

Display name of the step.

The email every contact receives.

body: str

Email body as Markdown, without the sign-off or signature, which are added when the message is written. Each {{ }} is a variable filled in per contact, with a fallback for a contact missing the value; a field variable names the field by the ad_ ID the field-definitions endpoints list.

subject: str

Plain-text subject line. Each {{ }} is a variable filled in per contact, with a fallback for a contact missing the value; a field variable names the field by the ad_ ID the field-definitions endpoints list.

type: Literal["EMAIL"]

Step type.

class DataDefinitionStepUnionMember3: …

id: str

Step identifier, referenced by enrollment currentStepId and message sequenceStepId.

delivery_mode: Literal["AUTO", "FOR_REVIEW"]

AUTO sends without manual approval, subject to the send window and limits; FOR_REVIEW requires a person to approve the draft before sending.

One of the following:

"AUTO"

"FOR_REVIEW"

mode: Literal["TEMPLATE"]

How each message is written: AGENT composes it from prompt; TEMPLATE sends template to every contact, with its variables filled in.

Display name of the step.

The message every contact receives; for an invite, its connection note, sent only with includeNote.

body: str

Plain-text message. Each {{ }} is a variable filled in per contact, with a fallback for a contact missing the value; a field variable names the field by the ad_ ID the field-definitions endpoints list.

type: Literal["LINKEDIN_MESSAGE"]

Step type.

class DataDefinitionStepUnionMember4: …

id: str

Step identifier, referenced by enrollment currentStepId and message sequenceStepId.

delivery_mode: Literal["AUTO", "FOR_REVIEW"]

AUTO sends without manual approval, subject to the send window and limits; FOR_REVIEW requires a person to approve the draft before sending.

One of the following:

"AUTO"

"FOR_REVIEW"

include_note: bool

Whether the connection request carries a note. A step authored before this setting existed reads as true.

mode: Literal["TEMPLATE"]

How each message is written: AGENT composes it from prompt; TEMPLATE sends template to every contact, with its variables filled in.

Display name of the step.

The message every contact receives; for an invite, its connection note, sent only with includeNote.

body: str

type: Literal["LINKEDIN_INVITE"]

Step type.

class DataDefinitionStepUnionMember5: …

id: str

Step identifier.

duration: int

Length of the wait.

minimum-9007199254740991

maximum9007199254740991

type: Literal["WAIT", "WAIT_FOR_CONNECTION"]

WAIT pauses for a fixed time; WAIT_FOR_CONNECTION waits up to that long for a LinkedIn invite to be accepted.

One of the following:

"WAIT"

"WAIT_FOR_CONNECTION"

unit: Literal["DAY", "MINUTE"]

Unit of duration.

One of the following:

"DAY"

"MINUTE"

first_activated_at: Optional[str]

When the sequence was first activated.

last_activated_at: Optional[str]

When the sequence was most recently activated.

Name of the sequence.

object_type: Literal["sequence"]

Always sequence.

reviewers: List[DataReviewer]

Extra members who may approve this sequence’s FOR_REVIEW messages before they send. The sending member and the sequence’s creator always review, whether or not they are listed.

id: str

ID of the member.

minLength1

object_type: Literal["member"]

Always member.

senders: List[DataSender]

The senders this sequence sends from; new contacts rotate across them. An archived sender stays listed but never sends; any change to the list drops it.

id: str

ID of the sender.

minLength1

object_type: Literal["sender"]

Always sender.

status: Literal["DRAFT", "ACTIVE", "DEACTIVATED"]

DRAFT has not been published; ACTIVE is enabled for sending; DEACTIVATED is published but paused.

One of the following:

"DRAFT"

"ACTIVE"

"DEACTIVATED"

object: Literal["list"]

total_count: int

minimum-9007199254740991

maximum9007199254740991

List sequences

from lightfield import Lightfield

client = Lightfield(
    api_key="My API Key",
)
sequence_list_response = client.sequence.list()
print(sequence_list_response.data)

{
  "data": [
    {
      "id": "id",
      "channels": [
        "EMAIL"
      ],
      "createdAt": "createdAt",
      "definition": {
        "description": "description",
        "messaging": {
          "callToAction": "callToAction",
          "persona": "persona",
          "trigger": "trigger",
          "valueProp": "valueProp"
        },
        "pacing": {
          "EMAIL": {
            "dailyLimit": -9007199254740991
          },
          "LINKEDIN_INVITE": {
            "dailyLimit": -9007199254740991
          },
          "LINKEDIN_MESSAGE": {
            "dailyLimit": -9007199254740991
          }
        },
        "priority": "HIGH",
        "sendWindow": {
          "daysOfWeek": [
            -9007199254740991
          ],
          "endHour": -9007199254740991,
          "startHour": -9007199254740991,
          "timezone": "timezone"
        },
        "steps": [
          {
            "id": "id",
            "deliveryMode": "AUTO",
            "mode": "AGENT",
            "name": "name",
            "prompt": "prompt",
            "type": "EMAIL"
          }
        ]
      },
      "firstActivatedAt": "firstActivatedAt",
      "lastActivatedAt": "lastActivatedAt",
      "name": "name",
      "objectType": "sequence",
      "reviewers": [
        {
          "id": "x",
          "objectType": "member"
        }
      ],
      "senders": [
        {
          "id": "x",
          "objectType": "sender"
        }
      ],
      "status": "DRAFT"
    }
  ],
  "object": "list",
  "totalCount": -9007199254740991
}

Returns Examples

{
  "data": [
    {
      "id": "id",
      "channels": [
        "EMAIL"
      ],
      "createdAt": "createdAt",
      "definition": {
        "description": "description",
        "messaging": {
          "callToAction": "callToAction",
          "persona": "persona",
          "trigger": "trigger",
          "valueProp": "valueProp"
        },
        "pacing": {
          "EMAIL": {
            "dailyLimit": -9007199254740991
          },
          "LINKEDIN_INVITE": {
            "dailyLimit": -9007199254740991
          },
          "LINKEDIN_MESSAGE": {
            "dailyLimit": -9007199254740991
          }
        },
        "priority": "HIGH",
        "sendWindow": {
          "daysOfWeek": [
            -9007199254740991
          ],
          "endHour": -9007199254740991,
          "startHour": -9007199254740991,
          "timezone": "timezone"
        },
        "steps": [
          {
            "id": "id",
            "deliveryMode": "AUTO",
            "mode": "AGENT",
            "name": "name",
            "prompt": "prompt",
            "type": "EMAIL"
          }
        ]
      },
      "firstActivatedAt": "firstActivatedAt",
      "lastActivatedAt": "lastActivatedAt",
      "name": "name",
      "objectType": "sequence",
      "reviewers": [
        {
          "id": "x",
          "objectType": "member"
        }
      ],
      "senders": [
        {
          "id": "x",
          "objectType": "sender"
        }
      ],
      "status": "DRAFT"
    }
  ],
  "object": "list",
  "totalCount": -9007199254740991
}