Sequences

List Sequence Related Records

Which linked record each contact's related fields use in this sequence, held-back contacts first.

Limited to relationships the credential may read and to contacts inside its contact read scope. unavailable_fields names required related fields that no readable relationship provides.

get/sequences/{sequence_id}/related-records

Request

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

Path parameters

sequence_idstring required

Sequence id.

Query parameters

status'pinned' | 'blocked' nullable

Only pinned or only held-back contacts.

limitinteger
offsetinteger

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Response

Successful Response

dataSequenceRelatedRecordsPayload required

Related-record variables, pins or an enrolment result for a sequence.

Changes

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