Contacts
List contacts in audience
Returns contacts belonging to an audience. Requires contacts:read scope.
Authorization
bearerAuth AuthorizationBearer <token>
Bearer token authentication. Use a Regular API key for email sending, or an Admin API key for marketing and automation endpoints.
Get your API keys from Settings → API Keys (regular) or Settings → Admin API Keys (admin) in the dashboard.
In: header
Query Parameters
audienceId*string
Audience ID.
Format
uuidpage?integer
Default
1limit?integer
Default
20Range
value <= 100sortBy?string
Default
"created_at"Value in
"email" | "first_name" | "last_name" | "created_at"sortDir?string
Default
"desc"Value in
"asc" | "desc"subscribedOnly?boolean
When true, returns only subscribed contacts.
Default
falseResponse Body
application/json
curl -X GET "https://api.keplars.com/api/v1/public/contacts/get-contacts?audienceId=497f6eca-6276-4993-bfeb-53cbbbba6f08"{
"success": true,
"message": "Success",
"data": {
"contacts": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"email": "[email protected]",
"first_name": "string",
"last_name": "string",
"phone": "string",
"status": "subscribed",
"tags": [
"string"
],
"custom_fields": {},
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"page": 0,
"limit": 0,
"total": 0,
"totalPages": 0
}
}