Workflow settings

Read the workflows on your instance from the settings area: list them or retrieve one.

Workflow settings give read-only access to the workflows set up on your instance. You can list them and retrieve one; changes go through the workflows endpoints. This area has 2 endpoints, and all seven SDKs call every one.

At a glance

Endpoint	Method	Path	What it does
List workflows (settings path)	GET	/settings/workflows	Lists the workflows on your instance from the settings area, one page at a time.
Retrieve a workflow (settings path)	GET	/settings/workflows/{workflow_id}	Retrieves one workflow from the settings area by its id.

Before you call

Register your API credentials once when your app starts, as shown in Authentication. Every SDK sample on these pages then gets its client in one line. With cURL, send the access token in an Authorization header: Authorization: Bearer $ACCESS_TOKEN.

Things to know

• This area is read only. Every write under /settings/workflows is refused with 400; create, update and delete workflows under /workflows.
• One workflow comes back under workflow. A listing puts its records under data.
• Listings page by cursor. Records sit under data; pass pagination.next_cursor as cursor to read the next page, and stop when pagination.has_more is false.