v1

latestOpenAPI 3.1.02026-07-26359254.7 MB

Sequence Contacts

Get a contact in a sequence

<small>Requires the sequences:read scope (or a broader one that includes it).</small>

Returns details of a specific contact enrolled in the sequence.

get/v3/sequences/{id}/contacts/{contact_id}

Path parameters

idinteger required

Sequence ID

contact_idinteger required

Contact ID

Response

Contact details retrieved successfully

contactIdinteger

Contact ID

sequenceIdinteger

Sequence ID

emailstring nullable

Contact email address

firstNamestring nullable

Contact first name

lastNamestring nullable

Contact last name

companystring nullable

Contact company name

titlestring nullable

Contact job title

statusInSequence'active' | 'paused' | 'finished' | 'inactive' | 'outOfOffice'

Contact's status in this sequence. The writable subset (active, paused, finished, outOfOffice) can be set via POST /v3/sequences/{id}/contacts/set-status-in-sequence. inactive is set by the system when the contact is missing data needed to continue (e.g. no email when the next step is an email step).

isOptedOutboolean

Whether the contact has opted out (contact-level flag, not sequence-scoped)

callStatus'none' | 'toCall' | 'called'

Contact-level call status. Set via PATCH /v3/contacts/{id} (callStatus field). Pass none to clear.

meetingStatus'none' | 'meetingBooked'

Contact-level meeting status. Set via PATCH /v3/contacts/{id} (meetingStatus field). Pass none to clear.

addingDatestring date-time

Date the contact was added to the sequence

emailAccountIdinteger nullable

Identifier of the email account this contact is assigned to send from in this sequence. null when no email account is assigned (e.g. the sequence has no email steps the contact has reached, or the assignment hasn't been resolved yet).

linkedInAccountIdinteger nullable

Identifier of the LinkedIn account this contact is assigned to send from in this sequence. null when no LinkedIn account is assigned (e.g. the sequence has no LinkedIn steps the contact has reached).

Example response

{
  "contactId": 12345,
  "sequenceId": 100,
  "email": "john.doe@company.com",
  "firstName": "John",
  "lastName": "Doe",
  "company": "Tech Solutions Inc",
  "title": "Senior Product Manager",
  "statusInSequence": "active",
  "isOptedOut": false,
  "callStatus": "none",
  "meetingStatus": "none",
  "emailDisposition": {
    "isReplied": false,
    "isBounced": false
  },
  "currentStep": {
    "stepId": 5421,
    "displayName": "2"
  },
  "addingDate": "2024-03-08T10:00:00+00:00",
  "emailAccountId": 101,
  "linkedInAccountId": null
}