Get Contacts

get

https://app.campaignrefinery.com/rest/contacts/get-contacts

Query Params

key

string

required

Your API key (required)

string

Term search allow to query contacts containing name or email with a specific term (optional)

contact_add_start

date

Starting date/time contact has been created. Date must be formatted as ISO 8601 like 2022-08-01 08:00:00 and have its timezone offset as UTC (optional)

contact_add_end

date

Ending date/time contact has been created. Date must be formatted with ISO 8601 such as 2022-08-01 23:59:59 and have its timezone offset as UTC (optional)

contact_update_start

date

Starting date/time contact has been updated. Date must be formatted as ISO 8601 like 2022-08-01 08:00:00 and have its timezone offset as UTC (optional)

contact_update_end

date

Ending date/time contact has been updated. Date must be formatted as ISO 8601 like 2022-08-01 23:59:59 and have its timezone offset as UTC (optional)

offset

int32

Defaults to 0

Each request returns a maximum of 100 rows, offset specifies which page to load when running subsequent requests to query more than 100 rows; first page offset is 0, second page offset is 100, and so on. Whenever the number of returned rows is less than 100 then pagination has reached the end (optional)

order_by

string

Defaults to contact_email

Column to order results by (optional)

sort

string

Defaults to asc

Sort direction (asc or desc) (optional)

Responses

Language

Request

Response

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

application/json

200200

400400