Retrieve a workflow
The workflow itself — its trigger, re-entry policy and rate cap. The step graph is not part of the v1 contract.
Requires the workflows:read scope — View your automation workflows and their runs.
AuthorizationBearer <API Key>API key authentication. Use a sk_* (FULL) or pk_* (SENDING_ONLY) key as the bearer token. Public keys (pk_*) are restricted to the email-send endpoints and the self-serve list subscribe/unsubscribe pair; every other endpoint — event tracking included — answers 403 for them. In scope terms (used by /api/v1/* operations): FULL keys hold every scope; SENDING_ONLY keys hold only emails:send.
id*stringWorkflow id.
uuidWorkflow
application/json- response
An automation workflow as exposed on the v1 API.
id*stringuuidname*stringdescription*string|nullenabled*booleantrigger_type*string"EVENT""MANUAL""SCHEDULE"event_name*|Trigger event for EVENT workflows; null for the other trigger types.
allow_reentry*booleanmax_executions_per_hour*integer|nullversion*integerIncremented on every structural (step/transition) change.
step_count*integerSteps in this workflow's graph, trigger step included — so a workflow that has only ever been created reports 1. Read /graph for the steps themselves.
created_at*stringdate-timeupdated_at*stringdate-timecurl -X GET 'https://api.sendly.now/api/v1/workflows/497f6eca-6276-4993-bfeb-53cbbbba6f08'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "description": "string", "enabled": true, "trigger_type": "EVENT", "event_name": "string", "allow_reentry": true, "max_executions_per_hour": 0, "version": 0, "step_count": 0, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z"}