Custom Roles
List Custom Roles
Get all Custom Roles for your organization.
get/custom_role
Query parameters
pageinteger
Page number. Starts at 1. Any value lower than 1 will be considered as 1. For the number of items per page, see the per_page query parameter.
per_pageinteger
Number of items to return per page. Currently limited to 100.
org_idinteger
Organization ID. Only PROVIDER users can specify a different organization. If not provided, defaults to your own organization.
only_available_rolesboolean
If true: only return roles for which the requesting user has all required permissions (Custom Fields permissions are also taken into account).
Response
OK
Example response
{
"page": 1,
"max_page": 10,
"count": 3,
"custom_roles": [
{
"name": "This is My Custom Role",
"api_id": "this_is_my_custom_role",
"description": "It has a custom permission configuration!",
"org_id": 42
}
]
}