Vixiees API

Sections

Theme switcher

Retrieves contacts

Header Parameters

X-Api-Keystring

Query Parameters

playbook_idstring

Filter by the contact's current playbook ID. A malformed ID returns an empty result set rather than an error.

flow_step_idstring

Filter by the contact's current flow step ID. A malformed ID returns an empty result set rather than an error.

wordsstring

Search terms to filter contacts

exact_searchboolean

Whether to perform an exact match search on email and phone

sortstring

Sort direction (asc or desc)

Enum values:
ascdesc
order_bystring

Field to order results by

pageinteger

Page number for pagination

Minimum
1
limitinteger

Number of records per page

Minimum
1
Maximum
100
created_at_fromstring

Filter by creation date from

created_at_tostring

Filter by creation date to

updated_at_fromstring

Filter by update date from

updated_at_tostring

Filter by update date to

Response

200
Object

contacts found

Response Attributes

resultsarray

Show child attributes

page_infoobject

Show child attributes

401
Object

unauthorized

Was this section helpful?

GET

/

Select
1

Response

Was this section helpful?