List All Workflow IDs

get

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

Returns only the identifiers of the workflows you can access, without workflow bodies, schemas, or attributes. Use this to determine which workflows are visible to your credentials without paying the cost of a full workflow listing.

Filtering and pagination behave the same as List All Workflows. Because each result contains only identifiers, pageSize may be set as high as 10000.

Results are always ordered by when the workflow was last updated; sortDirection controls only the direction.

This endpoint reflects indexed workflow visibility and does not load each workflow individually, so in rare cases it may list a workflow whose full representation is temporarily unavailable from List All Workflows.

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 10000

Defaults to 10000

A limit of the number of results to return. The identifier-only endpoints return a small, fixed amount of data per result, so they support a much larger page size than the corresponding list endpoints.

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

Allowed:

template

string

Filter workflows to a specific Template ID.

sortDirection

string

enum

Defaults to DESC

The direction to sort by. Default is 'DESC'.

Allowed:

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. 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. More information about permissions.

Responses

Language

Credentials

URL

Loading…

Response

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

application/json

200200

400400

401401

403403

404404