List Contacts

get http://api.tidyhq.com/v2/contacts

Fetchs list of all contacts in the current org, with optional lookup filtering applied.

Query Params

updated_since

date-time

ISO8601 formatted timestamp, only returns results last updated since the given time.

updated_before

date-time

ISO8601 formatted timestamp, only returns results last updated before the given time.

limit

integer

How many items per page to return

offset

integer

Paginated offset of items (how many to skip)

registered

boolean

When given, returns only users with / without a user account attached.

all

boolean

When given, returns all (including inactive) - defaults to only returning visible / active.

ids

string

When given (as a comma-seperated list), filters to those matching the given IDs. Can be combined with scope to specify the type of ID.

scope

If specified, applies ids to the specified type. If not given, will default to check the id reference or the id.

search_terms

string

If given, applies search terms (e.g. name / email) to filter the collection

filter_equals[PARAM_NAME]

string

Filters results to those that exactly match the field PARAM_NAME. You can supply this query param multiple times with different PARAM_NAMEs, and it will return the intersection of these equalities. Supported PARAM_NAMEs for this API: first_name, last_name, company, email_address, phone_number, kind, contact_id_number.

Response

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url http://api.tidyhq.com/v2/contacts \
3
     --header 'accept: application/json'

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

application/json

200OK