Returns data about all sequences a contact is part of — including:

• the last step they completed
• the step they're currently in
• and the next step that's coming up

Also, the ID and title of both the Sequence and Step are returned, making it easier to reference them in your system. You can filter the results using sequence_status and contact_status - here's what those mean:

• contact_status - tells you where the contact is inside a step:

  • "pending" - waiting to enter the step
  • "active" - currently in the step
  • "inactive" - currently inactive in the step. Won't receive the step message
  • "moved" - they've been moved to another step
  • "finished" - they've completed the step

• sequence_status - shows the state of the whole sequence:

  • "active" - working normally, accessible, contacts can be added and messages can be sent
  • "draft" - accessible but no contacts can be added and no messages can be sent
  • "archived" - old and not in use anymore

• Possible Body Parameters:

  • limit - the number of sequences to return
    • defaults to 50 when not provided
    • maximum is 500
  • offset - the number of sequences to skip
  • sequence_id - the ID of the Sequence to filter by. Could be used to check if a contact is in a specific sequence.
  • contact_status - status of the Contact in latest sequence step to filter by
    • possible values: pending, active, inactive, moved, finished
  • sequence_status - status of the Sequence to filter by
    • possible values: draft, active