Get automation details

Get a single automation with the counts of contacts that entered it, are moving through it, finished it or failed on the way.

Get automation details

get

Get a single automation with the counts of contacts that entered it, are moving through it, finished it or failed on the way.

This describes the automation itself. To see the workflow it runs, use the steps endpoint.

Authorizations

AuthorizationstringRequired

API Token authentication

Path parameters

profileUuidstringRequired

Profile uuid parameter

Example: 550e8400-e09b-41d4-a716-400055000000

automationUuidstringRequired

Automation uuid parameter

Example: 550e8400-e09b-41d4-a716-400055000000

Responses

200

Success response

application/json

uuidstringOptionalExample: 550e8400-e29b-41d4-a716-446655440000

namestringOptionalExample: Welcome series

statusstring · enumOptional

There is no completed status. Use events.completed to see how many contacts finished.

Example: activePossible values:

typestring · enumOptional

What kind of workflow this is. custom automations are the ones built from scratch.

Example: welcome_seriesPossible values:

configobject · nullableOptional

Trigger configuration of the automation. The shape depends on the type.

created_atstring · date-time · nullableOptionalExample: 2025-02-27T11:54:22Z

updated_atstring · date-time · nullableOptionalExample: 2025-03-04T09:12:07Z

401

Unauthenticated response

application/json

500

Error response

application/json

get/api/reach/v1/profiles/{profileUuid}/automations/{automationUuid}

GET /api/reach/v1/profiles/{profileUuid}/automations/{automationUuid} HTTP/1.1
Host: developers.hostinger.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "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"
}