Sign in

v1

latestOpenAPI 3.1.02026-08-065163115.0 KB
Roles

List roles

Returns the available roles that can be assigned to users within a business.

get/v1/businesses/{client_id}/roles

Path parameters

client_idinteger required
Example:123

The ID of the business.

Query parameters

offsetinteger
Example:50

Offset to retrieve items from.

limitinteger
Example:50

Number of items per page.

Response

OK

countinteger

The total number of roles for the business.

nextstring

The URL to the next page of roles.

previousstring

The URL to the previous page of roles.

Example response

{
  "count": 5,
  "next": "offset=50&limit=50",
  "previous": "offset=0&limit=50",
  "results": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "Team Member",
      "permissions": [
        {
          "resource": "transactions",
          "action": "read"
        }
      ]
    }
  ]
}