v1

latestOpenAPI 3.1.02026-07-2498134321.1 KB

Workflows

List Eligible Assignees for a Workflow Role

Returns a paginated list of users eligible to be assigned to the specified role on the workflow along with the user ID of current assignee if a user is already assigned to the role.

OAuth Scope required: public.workflows.readRoleAssignees

get/workflows/{id}/roles/{roleName}/eligible-assignees

Path parameters

idstring required

The unique identifier or Ironclad ID of a workflow.

roleNamestring required

The display name of the role, URL-encoded (e.g. Legal%20Approver).

Query parameters

pageinteger

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

pageSizeinteger

A limit of the number of results to return.

Headers

x-as-user-emailstring

Example:jane.doe@test.com

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-idstring

Example:5f0375c4cdc1927a3c5edcd3

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

200

pageinteger required

The zero-based page number for paginating through results.

pageSizeinteger required

The number of items to return per page

countinteger required

The total number of items available across all pages

Example response

{
  "pageSize": 20,
  "count": 1,
  "list": [
    {
      "userId": "61968ae4945dcecf4a78cc83",
      "email": "lilbieber@gmail.com",
      "displayName": "Justin Bieber"
    }
  ],
  "defaultAssignee": {
    "userId": "63d415e0dd0d828c3a878548",
    "email": "tate.mcrae@gmail.com",
    "displayName": "Tate McRae"
  }
}