Reach: Automations
List automations
Get a paginated list of the automations in a profile.
Every automation comes with the counts of contacts that entered it, are moving through it, finished it or failed on the way. Those counts describe the contact journey and are not email engagement metrics - for opens, clicks and unsubscribes use the campaign statistics endpoint instead.
get/api/reach/v1/profiles/{profileUuid}/automations
Path parameters
profileUuidstring required
Example:550e8400-e09b-41d4-a716-400055000000
Profile uuid parameter
Query parameters
status'active' | 'paused' | 'draft'
Example:active
Filter automations by status.
There is no completed status. An automation that has finished for every contact still reports active.
sort_direction'asc' | 'desc'
Example:desc
Order automations by creation date. Newest first unless set to asc.
pageinteger
Example:1
Page number
per_pageinteger
Example:25
Number of items per page
Response
Success response
Example response
{
"data": [
{
"uuid": "550e8400-e29b-41d4-a716-446655440000",
"name": "Welcome series",
"status": "active",
"type": "welcome_series",
"events": {
"started": 10,
"in_progress": 5,
"completed": 4,
"failed": 1
},
"created_at": "2025-02-27T11:54:22Z",
"updated_at": "2025-03-04T09:12:07Z"
}
],
"meta": {
"current_page": 1,
"per_page": 15,
"total": 100
}
}