API Reference
API ReferenceSubmit a Ticket

Get Contacts

get
https://api.campaignrefinery.com/rest/contacts/get_contacts

Returns a paginated list of contacts in the authenticated account. Each row is identified by contact_uuid. Optional with_attributes=true adds a nested custom_attributes map per contact (default omits, opt-in). Pagination uses the standard paginated response envelope inside data ({current_page, data: [...], total, per_page, last_page, ...}).

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

Substring search on contact name or email.

integer
≥ 1
Defaults to 1

Page number (1-indexed). Default 1.

integer
1 to 100
Defaults to 25

Page size. Default 25, capped at 100.

string
enum

Field to sort by. Whitelist enforced.

Allowed:
string
enum
Defaults to desc

Sort direction. Default desc (newest first).

Allowed:
string

ISO 8601 UTC datetime. Filter to contacts created after this time.

string

ISO 8601 UTC datetime. Filter to contacts created before this time.

string

ISO 8601 UTC datetime. Filter to contacts updated after this time.

string

ISO 8601 UTC datetime. Filter to contacts updated before this time.

boolean
Defaults to false

When true, each contact in the response includes a nested custom_attributes: {key: value} map. Default false (omitted).

Responses

401

Missing or invalid bearer token.

Updated 13 days ago

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

Updated 13 days ago