GuidesChangelogAPI Reference
API Reference

/api/v5/user_role/

get
https://percolate.com/api/v5/user_role/

Get a list of user_roles.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

A CSV of unique UserRole IDs to filter by

string

A CSV of scope IDs to filter by.

boolean
Defaults to false

Look inside any child scopes in addition to the supplied ones.

boolean

If true is specified, use request user's ID from session to filter.

integer

Limit the number of paginated results.

integer

A 0-based offset to adjust the pagination window.

string

A CSV of unique user IDs to filter by.

string

A CSV of unique role IDs to filter by.

string
enum

Apply this to any method that supports sorting.

Allowed:
string
enum

Control order direction.

Allowed:
string

Filters results matching user.name or user.email

string

A CSV of capability codes. Filters results for roles having the specified capabilities.

string

Reduce the result set so that the user_id or role_id is unique. If there are multiple scopes with the same role/user, best effort is made to select one.

boolean

If true, disabled users should be filtered out.

boolean
Defaults to false

If true, only return user_roles explicitly in the requested scope.

boolean

If true, only return user_roles for users that have SSO disabled. If false, only return user_roles for users that have SSO enabled.

boolean

If true, enable superusers to fetch all users via staff admin page.

string
enum

Includes related items in the response.

Allowed:
Responses

Retry-After header

500

Internal server error

Updated over 2 years ago

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 2 years ago