List Segments
Retrieve a paginated list of the segments available to your account.
Request
GET /segments
Query Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
page | integer | 1 | Page number (min: 1) |
per_page | integer | 100 | Items per page (min: 1, max: 100) |
search | string | - | Search by segment name (max 255 characters) |
Ordering: Results are ordered by created_at descending (newest first).
Example Request
curl -X GET "https://email.easy.tools/api/v1/segments?page=1&per_page=50&search=lapsed" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Accept: application/json"
Response
Success Response (200 OK)
{
"data": [
{
"uuid": "9f1c2e7a-3b4d-4f8a-9c2e-1a2b3c4d5e6f",
"name": "Lapsed buyers",
"contacts_count": 1284,
"contacts_count_calculated_at": "2026-06-26T08:12:03Z",
"created_at": "2026-02-10T14:20:00Z",
"updated_at": "2026-06-25T09:01:11Z"
},
{
"uuid": "46fd66f9-fbe4-48b4-b5e2-0d7c0b18b46a",
"name": "Active customers",
"contacts_count": 0,
"contacts_count_calculated_at": null,
"created_at": "2026-01-14T09:00:00Z",
"updated_at": "2026-01-14T09:00:00Z"
}
],
"pagination": {
"current_page": 1,
"per_page": 50,
"total": 2
}
}
Response Fields
Each entry in data has the fields described in
Segment Object.
Pagination Object
| Field | Type | Description |
|---|---|---|
current_page | integer | Current page number |
per_page | integer | Number of items per page |
total | integer | Total number of segments |
Error Responses
Validation Error (422 Unprocessable Entity)
Returned when page or per_page is out of range.
{
"error": {
"code": "VALIDATION_ERROR",
"message": "The given data was invalid",
"details": {
"per_page": ["The per page field must not be greater than 100."]
}
}
}