For the complete documentation index, see llms.txt. This page is also available as Markdown.

List automations

Get a paginated list of the automations in a profile.

List automations

get

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.

Authorizations
AuthorizationstringRequired

API Token authentication

Path parameters
profileUuidstringRequired

Profile uuid parameter

Example: 550e8400-e09b-41d4-a716-400055000000
Query parameters
statusstring · enumOptional

Filter automations by status.

There is no completed status. An automation that has finished for every contact still reports active.

Example: activePossible values:
sort_directionstring · enumOptional

Order automations by creation date. Newest first unless set to asc.

Example: descPossible values:
pageintegerOptional

Page number

Example: 1
per_pageinteger · max: 100Optional

Number of items per page

Default: 25Example: 25
Responses
200

Success response

application/json
get/api/reach/v1/profiles/{profileUuid}/automations
GET /api/reach/v1/profiles/{profileUuid}/automations HTTP/1.1
Host: developers.hostinger.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "data": [
    {
      "uuid": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Welcome series",
      "status": "active",
      "type": "welcome_series",
      "config": {},
      "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
  }
}

Last updated

Was this helpful?