---
title: "List Eligible Assignees for a Workflow Role"
method: GET
path: "/workflows/{id}/roles/{roleName}/eligible-assignees"
tags: ["Workflows"]
---

# List Eligible Assignees for a Workflow Role

`GET /workflows/{id}/roles/{roleName}/eligible-assignees`

## Request

- Base URL: `https://ironcladapp.com/public/api/v1`
- URL: `https://ironcladapp.com/public/api/v1/workflows/{id}/roles/{roleName}/eligible-assignees`
- Auth: API key in header `Authorization` and OAuth 2
  - Authorization code: `https://ironcladapp.com/oauth/authorize`
  - Client credentials
  - Token URL: `https://ironcladapp.com/oauth/token` scopes: `public.workflows.readRoleAssignees`

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`

## Path parameters

- `id` string, required
- `roleName` string, required

## Query parameters

- `page` integer
- `pageSize` integer

## Headers

- `x-as-user-email` string
- `x-as-user-id` string

## Response `200`

200

- object
  - `page` integer, required: The zero-based page number for paginating through results.
  - `pageSize` integer, required: The number of items to return per page
  - `count` integer, required: The total number of items available across all pages
  - `list` object[], required: The list of users eligible to be assigned to the role
    - `userId` string, required
    - `email` string, required
    - `displayName` string, required
  - `defaultAssignee` object: The user assigned to the role by default.
    - `userId` string, required
    - `email` string, required
    - `displayName` string, required

## Other responses

- `404`: 404

---

[API](https://skmtc.dev/ironcladapp/apis/ironclad-public-api.md) - [All operations](https://skmtc.dev/ironcladapp/apis/ironclad-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ironcladapp/apis/ironclad-public-api/revisions/435da5a4396e?raw)