List All Workflows

List all workflows in your Ironclad account.

OAuth Scope required: public.workflows.readWorkflows

Log in to see full request history
Query Params
int32
Defaults to 0

The page number used when paginating through a list of results.

int32
1 to 100
Defaults to 20

A limit of the number of results to return.

status
array of strings

Filter the workflows that are listed based on their status. If this parameter is omitted, active workflows will be returned. Active workflows include workflows in the Create, Review, Sign, and Archive stages. Also accepts multiple comma-separated statuses to get workflows in more than one status.

status
string

Filter workflows to a specific Template ID.

string

Retrieve workflows that have been updated since a UTC date.

string

Filter workflows using a formula. The workflow attribute ID should be enclosed in brackets [ ] and the value should be enclosed in single quotes ' '.

Workflow attributes for a specific workflow design can be identified using the List All Workflow Schemas endpoint.

Supported formula operations include:

  • Equals
  • Contains
  • And
  • Or
For more information on writing formulas, please refer to this article.
Headers
string

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-id is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

string

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-email is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. More information about permissions.

Response

Language
Credentials
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json