Skip to content

List Sequence Related Fields

GET
/sequencer/related-fields

The variables (related.<definition>.<attribute>) a step can use from a contact’s linked custom-object records.

Only relationships to contacts whose custom object the credential may read (its own object grants) are offered, and only fields it may see. supported_step_types lists the step types whose sends fill them. 404 while the organisation’s relationships or record_context custom-object switch is off.

Authorizations

Parameters

Query Parameters

step_type
Any of:
string

Only the variables a step of this type can use.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

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

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string