Retrieve Workflows when you need Workflow configuration, participation results, or run history outside Odie. You can list Workflows, retrieve one Workflow, and retrieve its runs.
Use the Workflow endpoints
| Task | Endpoint |
|---|---|
| List Workflows | GET /v1/workflows |
| Retrieve one Workflow | GET /v1/workflows/{workflow_id} |
| List Workflow runs | GET /v1/workflows/{workflow_id}/runs |
List Workflows
curl "https://public-api.us.unison.totango.com/v1/workflows?page[limit]=25" \ --header "Authorization: Bearer <public_api_credential>"
The default page size is 25 Workflows and the maximum is 100.
Retrieve one Workflow
curl "https://public-api.us.unison.totango.com/v1/workflows/<workflow_id>" \ --header "Authorization: Bearer <public_api_credential>"
Understand Workflow fields
| Field | Description |
|---|---|
id |
The Workflow ID. |
name |
The Workflow name. |
description |
The Workflow description, when present. |
status |
The current Workflow status. |
target_type |
The type of record that participates in the Workflow. |
created_at |
When the Workflow was created. |
updated_at |
When the Workflow was last updated. |
created_by |
Information about the person who created the Workflow. |
participant_stats |
Current and total participant counts. |
objective_stats |
Objective completion and change ratios. |
List Workflow runs
curl "https://public-api.us.unison.totango.com/v1/workflows/<workflow_id>/runs?page[limit]=20" \ --header "Authorization: Bearer <public_api_credential>"
A Workflow run includes its status, entry and exit times, target, objective result, actions, duration, and the actor who added it. The default page size is 20 runs and the maximum is 50.
FAQs
Does retrieving a Workflow start or change it?
No. The Public API returns Workflow data and does not change Workflow participation or configuration.