V2 APIUsers
List roles
The roles a user can be given. Requires permission to view users. Roles are created and edited in the Resi app.
GET
/api/v2/rolesThe roles a user can be given. Requires permission to view users. Roles are created and edited in the Resi app.
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Query Parameters
account_id?string
Optional account to run this request against. Defaults to the account the API token is scoped to, so callers with a single account can omit it. Must be an account the authenticated user belongs to; staff may target any account. For write requests the value may be sent in the JSON body instead of the query string. The resolved account is returned on the X-Resi-Account-Id response header.
Format
uuidper_page?integer
Range
1 <= value <= 200Default
15Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/api/v2/roles"{ "data": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "key": "string", "name": "string", "slug": "string", "system_key": "string", "is_default": true, "is_protected": true, "permissions": { "property1": [ "string" ], "property2": [ "string" ] }, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" } ], "links": { "first": "string", "last": "string", "prev": "string", "next": "string" }, "meta": { "current_page": 0, "from": 0, "last_page": 0, "links": [ { "url": "string", "label": "string", "page": 0, "active": true } ], "path": "string", "per_page": 200, "to": 0, "total": 0 }}