GET {{baseUrl}}/roles/:roleId/members?page_count=<string>&page_number=1&next_page_token=<string>&page_size=30
User roles can have a set of permissions that allows access only to the pages a user needs to view or edit. Use this API to list all the members that are assigned a specific role. Prerequisites: Scopes: Rate Limit Label:
role:read:admin
Medium
Body
PARAM
Key | Datatype | Required | Description |
page_count
|
string | The number of pages returned for this request. | |
page_number
|
number | **Deprecated.** We will no longer support this field in a future release. Instead, use the `next_page_token` for pagination. | |
next_page_token
|
string | Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes. | |
page_size
|
number | The number of records returned within a single API call. |
HEADERS
Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
{
"members": [
{
"department": "<string>",
"email": "<string>",
"first_name": "<string>",
"id": "<string>",
"last_name": "<string>",
"type": "<integer>"
},
{
"department": "<string>",
"email": "<string>",
"first_name": "<string>",
"id": "<string>",
"last_name": "<string>",
"type": "<integer>"
}
],
"next_page_token": "<string>",
"page_count": "<integer>",
"page_number": 1,
"page_size": 30,
"total_records": "<integer>"
} |
ENDPOINTS