Skip to main content

List Contacts

Retrieve a paginated list of contacts with optional filtering.

Request

GET /contacts

Query Parameters

ParameterTypeDefaultDescription
pageinteger1Page number (min: 1)
per_pageinteger100Items per page (min: 1, max: 100)
searchstring-If valid email: exact match on email. Otherwise: search by first_name, last_name, phone, or full name (max 255 characters)
list_uuidstring-Filter by contact list membership

Ordering: Results are ordered by created_at descending (newest first).

Example Request

curl -X GET "https://email.easy.tools/api/v1/contacts?page=1&per_page=50&search=john" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Accept: application/json"

Response

Success Response (200 OK)

{
"data": [
{
"uuid": "550e8400-e29b-41d4-a716-446655440000",
"email": "john@example.com",
"first_name": "John",
"last_name": "Doe",
"phone": "+48123456789",
"external_id": "customer_123",
"language": "en",
"country_code": "US",
"created_at": "2025-01-15T10:30:00Z",
"updated_at": "2025-01-15T10:30:00Z"
},
{
"uuid": "660e8400-e29b-41d4-a716-446655440001",
"email": "john.smith@example.com",
"first_name": "John",
"last_name": "Smith",
"phone": null,
"external_id": null,
"language": "pl",
"country_code": null,
"created_at": "2025-01-14T09:00:00Z",
"updated_at": "2025-01-14T09:00:00Z"
}
],
"pagination": {
"current_page": 1,
"per_page": 50,
"total": 2
}
}

Response Fields

FieldTypeDescription
uuidstringContact's unique identifier
emailstringContact's email address
first_namestring|nullContact's first name
last_namestring|nullContact's last name
phonestring|nullContact's phone number
external_idstring|nullExternal identifier for integration purposes
languagestring|nullISO 639-1 language code (2 characters)
country_codestring|nullISO 3166-1 alpha-2 country code (2 characters)
created_atstringISO 8601 timestamp (UTC)
updated_atstringISO 8601 timestamp (UTC)

Pagination Object

FieldTypeDescription
current_pageintegerCurrent page number
per_pageintegerNumber of items per page
totalintegerTotal number of contacts

Error Responses

Validation Error (422 Unprocessable Entity)

{
"error": {
"code": "VALIDATION_ERROR",
"message": "The given data was invalid",
"details": {
"per_page": ["The per page must not be greater than 100."],
"list_uuid": ["The list uuid must be a valid UUID."]
}
}
}