List Eligible Assignees for a Workflow Role

get

https://na1.ironcladapp.com/public/api/v1/workflows/{id}/roles/{roleName}/eligible-assignees

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

The unique identifier or Ironclad ID of a workflow.

roleName

string

required

length ≤ 200

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

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.

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

404404