Index

Time	Status	User Agent
Retrieving recent requests…

Time

Status

User Agent

Retrieving recent requests…

string

full text search for attributes like contact.first_name, .last_name, .email, automation.name

automation_id

int32

only contacts for this automation, returns all automations if null

auto_response_scheduled

string

values: null => no filter; values: "1", "true", "on" and "yes" => returns contacts that have auto response scheduled; values: "0", "false", "off" and "no" => returns contacts that have NO auto response scheduled

show_greeted

boolean

Defaults to false

values: null, "0", "false", "off" and "no" => return only contacts that need to get a recording; values: "1", "true", "on" and "yes" => return all contacts

show_opted_out

boolean

Defaults to false

values: "1", "true", "on" and "yes" => returns contacts that have opted out; values: "0", "false", "off" and "no" => returns contacts that have NOT opted out

per_page

int32

Defaults to 25

number of contacts that are returned in pagination

page

int32

Defaults to 1

used for pagination, null will return first page

order_key

string

Defaults to created_at

used for ordering results (values: created_at,email,first_name,last_name,auto_response_scheduled_at)

order_direction

string

Defaults to ASC

used for selecting ordering direction (values: ASC,DESC)

contact_ids

string

comma separated list of contact ids that should be included in the response. use it to retrieve information about specific contacts. (e.g. 123,234)

200200

400400