Workflows

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.

get/api/v1/workflows/{id}

Request

  • Base URL: https://api.sendly.now
  • URL: https://api.sendly.now/api/v1/workflows/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie better-auth.session_token
    • OAuth 2 (authorization code, authorization URL https://app.sendly.now/api/auth/oauth2/authorize, token URL https://app.sendly.now/api/auth/oauth2/token, scopes: workflows:read)

Path parameters

idstring uuid required

Workflow id.

Response

Workflow

allow_reentryboolean required
created_atstring date-time required
descriptionstring nullable required
enabledboolean required
event_namestring nullable required

Trigger event for EVENT workflows; null for the other trigger types.

idstring uuid required
max_executions_per_hourinteger nullable required
namestring required
step_countinteger required

Steps 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.

trigger_type'EVENT' | 'MANUAL' | 'SCHEDULE' required
updated_atstring date-time required
versioninteger required

Incremented on every structural (step/transition) change.

Changes

No recorded changes to this operation across all 1 revision of this API.