List contacts
GET /v1/contacts
Returns a page of your workspace’s contacts, newest first.
Needs contacts:read.
Query parameters
Section titled “Query parameters”limit integer
How many items to return.
From 1 to 100. Default 25.
cursor string
The next_cursor of the previous page, unchanged. A cursor that was changed, or made for a different sort, is 400 invalid_request.
sort string
created_at lists newest first. updated_at lists oldest change first.
Default created_at.
phone string
Only the contact with this number. Any spelling of the number works
(spaces and dashes are ignored, and 00 counts as +). A number
that isn’t valid is 422 invalid_phone.
tag array of strings
Only contacts that have this tag. Repeat it to get contacts that have any of the tags (at most 50).
created_after string · date-time
Only contacts created after this time (RFC 3339).
updated_after string · date-time
Only contacts changed after this time (RFC 3339). A change shows up about 30 seconds after it’s saved.
Syncing changes
Section titled “Syncing changes”Use sort=updated_at to copy changes into your own system. A contact moves to the end of the list each time it changes. Resume a minute early and skip contacts you already have. See Pagination.
Phone numbers
Section titled “Phone numbers”A key with contacts:read sees full phone numbers. The app’s masking settings don’t apply to keys.
Returns
Section titled “Returns”200 A page of contact objects. A page of contacts.
Errors
Section titled “Errors”Besides the ones every request can get: