Skip to main content

Get sequence

GET 
/sequences/:sequence_id

Get sequence

Request​

Path Parameters

    sequence_id stringrequired
    Example: 0258cbc6-6020-430a-848e-aafacbadf4ae

Query Parameters

    include_raw_data boolean

    Whether to include raw data fetched from the 3rd party provider.

    Example: true

Header Parameters

    x-customer-id stringrequired

    The customer ID that uniquely identifies the customer in your application

    Example: my-customer-1
    x-provider-name stringrequired

    The provider name

    Example: salesforce

Responses​

Sequence

Schema
    owner_id stringnullable
    id stringrequired
    is_enabled booleanrequired
    name stringnullablerequired
    tags string[]required

    Raw values in Outreach, ids in Apollo, and not supported in Salesloft

    num_steps numberrequired
    metrics objectrequired
    property name* any
    created_at date-timenullablerequired
    updated_at date-timenullablerequired
    last_modified_at date-timerequired
    is_archived boolean

    When archived, cannot add contact to sequence or send mail.

    share_type string

    Possible values: [team, private]

    The share type of the sequence. If team will share with the whole team. private will only share with the owner.

    steps object[]

    Only returned when getting single sequence, not returned when listing sequences because it is too expensive to do so.

  • Array [
    • id string
    name string

    The name given by the user for the step. Used by Salesloft only.

    interval_seconds number

    The interval (in seconds) until this step will activate after the previous step (in case of first step, relative to when prospect first enters a sequence); only applicable to interval-based sequences. This is 0 by default

    date string

    The date this step will activate; only applicable to date-based sequences.

    template object

    The email/message template to be used for this step. Only applicable for email or message steps.

    id string

    The ID of the template

    body stringrequired

    The body of the email (HTML).

    subject stringrequired

    The subject of the email.

    name string

    The name of the template. In Outreach, if missing this will create an invisible template that doesn't show up in the templates list UI.

    to string[]

    A list of default person and email address pairs to receive this template in the "to" field

    cc string[]

    A list of default person and email address pairs to receive this template in the "cc" field

    bcc string[]

    A list of default person and email address pairs to receive this template in the "bcc" field

    is_reply boolean

    If true, this step will be sent as a reply to the previous step.

    order number

    The step's display order within its sequence. Only applicable for Outreach when adding steps one at a time after the initial sequence creation, otherwise when creating steps together with sequence order is implicit based on the order of step within the step array. Salesloft does not use the order param, and order is instead determined by interval_seconds which translates into the day parameter

    type stringrequired

    Possible values: [auto_email, manual_email, call, task, linkedin_send_message]

    The type of the sequence state. Note: linkedin_send_message is undocumented in Outreach and subject to change.

    See below for how these types are mapped:

    Providerauto_emailmanual_emailcalltasklinkedin_send_message
    Apolloauto_emailmanual_emailcallaction_itemlinkedin_send_message
    Outreachauto_emailmanual_emailcalltasklinkedin_send_message
    SalesloftEmailEmailPhoneOther(Not supported)
    task_note string

    An optional note to be attached to this step.

  • ]
Loading...