Get a role's users
Retrieve list of users associated with a specific role. For Dashboard instructions, review View Users Assigned to Roles.
This endpoint supports two types of pagination:
- Offset pagination
- Checkpoint pagination
Checkpoint pagination must be used if you need to retrieve more than 1000 organization members.
Checkpoint Pagination
To search by checkpoint, use the following parameters:
from: Optional id from which to start selection.take: The total amount of entries to retrieve when using the from parameter. Defaults to 50.
Note: The first time you call this endpoint using checkpoint pagination, omit the from parameter. If there are more results, a next value is included in the response. You can use this for subsequent API calls. When next is no longer included in the response, no pages are remaining.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
ID of the role to retrieve a list of users associated with.
Query Parameters
Number of results per page. Defaults to 50.
1 <= x <= 100Page index of the results to return. First page is 0.
x >= 0Return results inside an object that contains the total result count (true) or as a direct array of results (false, default).
Optional Id from which to start selection.
Number of results per page. Defaults to 50.
1 <= x <= 100