Get a list of contacts

Returns a paginated list of contacts. Supports filtering by organization number, creation and update timestamps, and free-text search, as well as sorting and pagination via query parameters.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Specify the organization number the contacts belong to.

string
enum

Define the sort order of the received payload. (asc/desc)

Allowed:
string
enum

Specify the field used for sorting.

Allowed:
number

Page number.

number

Define how many items will be received in the payload per request.(default 20 items, max 1000 items)

string

Allows to filter by the search phrase over fullName, email properties.

date-time

Filter by createdAt date FROM the provided value as an ISO UTC string. Inclusive.

date-time

Filter by createdAt date UNTIL the provided value as an ISO UTC string. Inclusive.

date-time

Filter by updatedAt date FROM the provided value as an ISO UTC string. Inclusive.

date-time

Filter by updatedAt date UNTIL the provided value as an ISO UTC string. Inclusive.

Responses

400

Bad Request

403

Forbidden

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json