Permissions
List Roles
This endpoint retrieves a list of all the roles for the given organisation. The roles are assigned to users to grant them permissions.
get/roles
Query parameters
querystring
A search query to filter roles by. This will search the role name.
archivedboolean
Whether to include archived resources in the response. When true, archived resources are returned; when false or omitted, only non-archived resources are returned.
pageinteger
The page to retrieve results from
per_pageinteger
The number of results to return per page
Response
The roles were successfully retrieved.
Example response
{
"links": {
"first": "http://example.com?page=1",
"next": "https://example.com?page=3",
"prev": "https://example.com?page=1",
"last": "https://example.com?page=4"
},
"meta": {
"from": 1,
"to": 2,
"total": 2,
"current_page": 1,
"last_page": 2,
"per_page": 15,
"path": "http://example.com/api"
},
"data": [
{
"name": "Spa Manager",
"description": "Allows access to settings for the assigned site.",
"permissions": [
"clients.view"
]
}
]
}Changes
No recorded changes to this endpoint across all 1 revision of this API.