Get all Contacts
GET/v3/contacts
Get all Contacts
Request
Query Parameters
contact_list_id number
Contact List Id
type string
Possible values: [unsubscribed
, active
, bounced
]
Filters type of contact
search string
Search string which will search all the properties of a contact for a matching value
limit number
Possible values: >= 1
and <= 50
Default value: 50
Number of records you would like in a request
page number
Possible values: >= 1
Default value: 1
Page of results
contact_type string
Possible values: [contact
, employee
]
Type of contact
created_date.gte date
Filter contacts created after the given date
created_date.lte date
Filter contacts created before the given date
Header Parameters
authorization stringrequired
Possible values: Value must match regular expression /Bearer [^\s]+/
Default value: Bearer <Token>
Custom Token generated from the App
Responses
- 200
Successful
- */*
- Schema
- Example (from schema)
Schema
has_next_page boolean
data string[]
{
"has_next_page": true,
"data": [
"string"
]
}
Loading...