List contacts

get

https://api.emaktalk.com/api/v1/contacts

Returns the contacts on your account that your API key is allowed to see. A bare request returns the whole contact book unpaged; supplying limit or search switches the endpoint into paged mode, and offset is only read once paging is engaged. searchTexts filters the page after it has been fetched, so combining it with paging can return short pages.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

string

Free-text search across the contact book; supplying it switches the endpoint into paged mode.

limit

integer

Page size, default 100 and capped at 500 (non-numeric or below 1 becomes 100); supplying it switches the endpoint into paged mode.

offset

integer

Row offset, read only in paged mode; non-numeric or negative values become 0.

fax_only

boolean

true keeps only contacts with at least one fax-capable number and reduces each one to its fax numbers; it cannot be combined with search or limit.

fields

string

slim returns a reduced contact: its ID, account ID, organization, first and last name, display name, and its phone numbers with their primary flag.

searchTexts

string

JSON object of per-field filters (organization, first_name, last_name, display_name, phone_number, email, anyfield) applied to the results in memory; invalid JSON is ignored.

Responses

200

The contacts you can see, as an array.

401

Missing or invalid API key.

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

400fax_only was combined with search or limit, or the read failed.

500Unexpected error.