Skip to main content

List Contacts

Retrieve a paginated list of contacts with optional filtering and search.

Endpoint

GET /api/v1/contacts

Headers

X-API-Key: sk_live_your_api_key

Query Parameters

ParameterTypeDescription
limitintegerNumber of contacts to return (max 100, default 10)
starting_afterstringCursor for pagination
tagstringFilter by tag
is_activebooleanFilter by active status
searchstringSearch in name, email, external_id
created_afterstringFilter contacts created after timestamp
created_beforestringFilter contacts created before timestamp

Example Request

curl -H "X-API-Key: sk_live_your_api_key" \
"https://api.sendmator.com/api/v1/contacts?limit=20&tag=customer&is_active=true"

Example Response

{
"data": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"external_id": "CRM-001",
"email": "john.doe@example.com",
"first_name": "John",
"last_name": "Doe",
"tags": ["customer", "vip"],
"is_active": true,
"created_at": "2024-01-15T10:30:00.000Z"
}
],
"has_more": true,
"next_cursor": "contact_def456ghi789"
}