List Contacts

get

https://a.eztexting.com/v1/contacts

List contacts matching provided filters

Query Params

page

integer

Defaults to 0

Offset of a given page. The default is 0. See pagination docs for more information.

size

string

enum

Defaults to 20

The maximum number of records to return in a paged list response. The default is 20 and allowed values are 10, 20, 50, 100, 200

Allowed:

sort

string

Sort field name and direction (asc or desc). Example: sort=created,desc

filters[phoneNumber][like]

string

Filter by phone number

filters[firstName][like]

string

Filter by first name

filters[lastName][like]

string

Filter by last name

filters[email][like]

string

Filter by email

filters[source][eq]

string

Filter by source: 'Unknown', 'WebInterface', 'Upload', 'WebWidget', 'API', 'Keyword'

filters[optOut][eq]

string

Filter by optOut status: true, false

filters[groupName][like]

string

Filter by group name

Responses

429

Too Many Requests

Language

Credentials

Response

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

*/*

200OK

400Bad Request

401Unauthorized

404Not Found

500Internal Server Error