List members in a role
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:
- A Pro or a higher plan.
Scopes: role:read:admin
Rate Limit Label: Medium
Request Params
| 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":"\u003cstring\u003e","email":"\u003cstring\u003e","first_name":"\u003cstring\u003e","id":"\u003cstring\u003e","last_name":"\u003cstring\u003e","type":"\u003cinteger\u003e"},{"department":"\u003cstring\u003e","email":"\u003cstring\u003e","first_name":"\u003cstring\u003e","id":"\u003cstring\u003e","last_name":"\u003cstring\u003e","type":"\u003cinteger\u003e"}],"next_page_token":"\u003cstring\u003e","page_count":"\u003cinteger\u003e","page_number":1,"page_size":30,"total_records":"\u003cinteger\u003e"}