List All Workflows

get

https://ironcladapp.com/public/api/v1/workflows

List all workflows in your Ironclad account.

OAuth Scope required: public.workflows.readWorkflows

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

int32

0 to 100000000

Defaults to 0

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

pageSize

int32

1 to 100

Defaults to 20

A limit of the number of results to return.

hydrateEntities

boolean

Defaults to false

Indicates whether to fully hydrate related entities (true) or return minimal information (false).

status

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. To get workflows in more than one status, pass a comma-separated list (status=active,completed) or repeat the parameter (status=active&status=completed). Supported statuses: active, paused, completed, cancelled.

template

string

Filter workflows to a specific Template ID.

lastUpdated

string

Retrieve workflows that have been updated since a UTC date.

filter

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 the following with documentation found here:

Equals / NotEqual
Contains
IsEmpty / IsNotEmpty
LessThan / LessThanOrEqual
GreaterThan / GreaterThanOrEqual
Date / Today / RelativeDate
And / Or

string

length ≤ 1000

Free-text search across all workflow properties, matching the in-app search. Combined with filter and any other parameters using logical AND. Maximum 1000 characters.

Headers

x-as-user-email

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. A token produced from the Authorization Code grant (which is already scoped to a user) may also use this header to act as a different user in the same company, provided the token carries the identity.users.impersonate scope and the token's own user has been granted the API User Impersonation permission. A request that sends this header without both never acts as the named user; depending on the company's configuration it either proceeds as the token's own user or is rejected with a 403. More information about permissions.

x-as-user-id

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. A token produced from the Authorization Code grant (which is already scoped to a user) may also use this header to act as a different user in the same company, provided the token carries the identity.users.impersonate scope and the token's own user has been granted the API User Impersonation permission. A request that sends this header without both never acts as the named user; depending on the company's configuration it either proceeds as the token's own user or is rejected with a 403. More information about permissions.

Response

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200