Sign in
latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-173284041.1 MB

8b0328d323ca

Reach: Automations

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.

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

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

Path parameters

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

Profile uuid parameter

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

Automation uuid parameter

Response

Success response

uuidstring
namestring
status'active' | 'paused' | 'draft'

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

type'welcome' | 'welcome_series' | 'promotional_series' | 'trust_building_series' | 'ecommerce_abandoned_cart' | 'ecommerce_recommend_after_purchase' | 'ecommerce_post_purchase' | 'ecommerce_discount_after_purchase' | 're_engagement_non_openers' | 're_engagement_non_clickers' | 'form_submitted' | 'custom'

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

configobject nullable

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

created_atstring date-time nullable
updated_atstring date-time nullable

Example response

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