Sequences

List Sequence Contact Ids

EVERY contact id in a sequence matching the filters, unpaginated.

The companion to the paged GET /sequences/{id}/contacts, for "act on all of them" without walking pages. The app's AG Grid filterModel string is a UI grid's internal format and is not offered; every app parameter not offered here has a default (pinned by a test).

get/sequences/{sequence_id}/contact-ids

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/sequences/{sequence_id}/contact-ids
  • Auth: HTTP bearer

Path parameters

sequence_idstring required

Sequence id.

Query parameters

searchstring nullable

Free text over name, email and phone.

state_filterstring nullable

Comma-separated states to INCLUDE.

exclude_statesstring nullable

Comma-separated states to EXCLUDE; composes with state_filter.

mailbox_filterstring nullable

Allocated mailbox contains.

phone_allocated_filterstring nullable

Allocated phone number contains.

company_filterstring nullable

Company name contains.

step_order_filterinteger nullable

Currently at this step order.

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Response

Successful Response

dataSequencerPayload required

An open envelope around one sequencer record.

Open because templates, schedules and channels carry nested step data and configuration that grows as channels are added.

Changes

No recorded changes to this operation across all 3 revisions of this API.