Skip to main content

List Automations

Retrieve a paginated list of automations, newest first.

Request​

GET /automations

Query Parameters​

All parameters are optional and combined.

ParameterTypeDefaultDescription
pageinteger1Page number (min: 1)
per_pageinteger100Items per page (min: 1, max: 100)
searchstring—Partial, case-insensitive match on the name (max 255 characters)
statusstring—Return only automations with this status: draft, active, or paused. See Statuses.

An unknown status, or an out-of-range page or per_page, returns 422 VALIDATION_ERROR.

Results are ordered by created_at descending. pagination.total is the number of automations that match the filters.

Example Request​

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

Response​

Success Response (200 OK)​

Each item includes structure and trigger, and omits steps. Read one automation for the chain. structure branched can still have steps on that read when the chain ends in an audience branch. See Structure.

{
"data": [
{
"uuid": "2b34fffc-17ef-4062-8900-e4a62e3337c5",
"name": "Welcome series branch",
"status": "draft",
"structure": "branched",
"trigger": {
"type": "contact_added_to_list",
"list_uuid": "cd9a83c7-f3ac-49ff-8031-adf6b455d8b8",
"segment_uuid": null,
"product_uuid": null,
"variant_uuid": null,
"waitlist_uuid": null,
"conditions": null
},
"created_at": "2026-09-30T11:52:46Z",
"updated_at": "2026-09-30T11:52:46Z"
},
{
"uuid": "976854b8-692b-4f5e-aca9-30b3053de7ae",
"name": "Welcome series",
"status": "draft",
"structure": "linear",
"trigger": {
"type": "contact_added_to_list",
"list_uuid": "cd9a83c7-f3ac-49ff-8031-adf6b455d8b8",
"segment_uuid": null,
"product_uuid": null,
"variant_uuid": null,
"waitlist_uuid": null,
"conditions": null
},
"created_at": "2026-09-29T11:58:38Z",
"updated_at": "2026-09-29T11:58:38Z"
}
],
"pagination": {
"current_page": 1,
"per_page": 100,
"total": 2
}
}

Response Fields​

FieldTypeDescription
uuidstringAutomation's unique identifier
namestringAutomation name
statusstringdraft, active, or paused. See Statuses.
structurestringlinear or branched. See Structure.
triggerobject|nullEnrollment trigger, or null when unset. See Trigger Object.
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 automations that match the filters

Error Responses​

Validation Error (422 Unprocessable Entity)​

{
"error": {
"code": "VALIDATION_ERROR",
"message": "The given data was invalid",
"details": {
"status": ["The selected status is invalid."]
}
}
}