List automation steps

Get the workflow of an automation as a flat list of steps.

List automation steps

get

Get the workflow of an automation as a flat list of steps.

The steps form a tree rather than a straight line: follow parent_uuid to reconstruct the branches, and use step_order to order the steps that share a parent. An automation with no steps yet returns an empty list.

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

Array of Reach.V1.Automations.Steps.AutomationStepResource

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

parent_uuidstring · nullableOptional

The step this one branches from. Null for the entry point of the workflow.

Example: 2080cc86-e026-4f7b-9598-d4132f8c7c2f

step_orderintegerOptional

Position of this step among the steps sharing its parent.

Example: 1

typestring · enumOptional

Role of the step in the workflow. A conditional step branches into several children.

Example: actionPossible values:

valuestring · enumOptional

The concrete trigger, action, decision or delay this step performs.

Example: send_emailPossible values:

configobject · nullableOptional

Step configuration. The shape depends on the value, and is empty for steps that take none.

401

Unauthenticated response

application/json

500

Error response

application/json

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

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

[
  {
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "parent_uuid": "2080cc86-e026-4f7b-9598-d4132f8c7c2f",
    "step_order": 1,
    "type": "action",
    "value": "send_email",
    "config": {}
  }
]