Roles

Returns every role defined in the organization along with the flat set of permission keys it grants. Each permission is an opaque, colon-delimited string; treat it as an opaque identifier and do not rely on its internal structure.

get/roles

Request

Query parameters

limitinteger

Maximum number of rows to return in the page.

cursorstring

If defined, a cursor to retrieve the next page.

Example:iLQvkEj3sh3UiweC

Pagination cursor to navigate through the full response.

Response

OK

Example response

{
  "roles": [
    {
      "id": "7a1b2c3d-4e5f-6789-abcd-ef0123456789",
      "name": "Accountant Admin",
      "permissions": [
        "ap:vendors:view"
      ]
    }
  ],
  "pagination": {
    "next_cursor": "iLQvkEj3sh3UiweC"
  }
}

Changes