Skip to main content
GET
List contacts
Each contact has the fields described in Contact fields. Use meta.totalPages to know when you’ve fetched every page. A customer list ID that doesn’t exist, or isn’t yours, returns an empty list rather than an error.

How search works

search is split into words. A contact matches if any word matches:
  • Name: the word appears in the first or last name, or is spelled similarly. Not case-sensitive.
  • Phone number: a word made only of digits, optionally starting with +, also matches phone numbers that contain it. Numbers are stored in E.164 form (+201001234567), so search with digits as they appear there: no spaces, dashes, brackets or leading 0.
When you filter by phoneNumber, send the number in E.164 form with no spaces, and encode the + as %2B in the URL.

Authorizations

X-API-KEY
string
header
required

Path Parameters

customerListId
string<uuid>
required

The customer list's id.

Query Parameters

page
integer
default:1

Page number, starting at 1.

Required range: x >= 1
limit
integer
default:10

Contacts per page.

Required range: x >= 1

Finds contacts by name or phone number. See How search works.

phoneNumber
string

Only contacts whose number contains this one. Send it in E.164 form with no spaces, for example +201001234567, and encode + as %2B.

email
string<email>

Only contacts whose email contains this one. Must be a full email address.

Response

A page of contacts.

message
string
Example:

"Contacts fetched successfully"

meta
object
data
object[]