Skip to main content
POST

Authorizations

string | header
required
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

Search parameters for retrieving contacts within a list
string
required
The ID of the contact list to search in.Example: "60d5ec49f1b2c72d9c8b4567"
integer
Page number for pagination (starts at 1).Minimum: 1Default: 1Example: 1
integer
Number of results per page.Range: 1 - 100Default: 20Example: 20
string
Filter contacts by email address (partial match).Example: "jane"

Response

Contacts retrieved successfully
boolean
Indicates if the request was successfulExample: true
object