Sign in
Roles

List system permissions

Changed on

The returned list can be sorted by system permission name or ID in ascending or descending order. The number of records to return at a time can also be controlled using the page_size query string parameter.

System permissions control what organization users can do in the self-serve portal.

<div> <code>read:system_permissions</code> </div>
get/api/v1/system_permissions

Request

  • Base URL: https://your_kinde_subdomain.kinde.com
  • URL: https://your_kinde_subdomain.kinde.com/api/v1/system_permissions
  • Auth: HTTP bearer

Query parameters

sort'name_asc' | 'name_desc' | 'id_asc' | 'id_desc' nullable

Field and order to sort the result by.

page_sizeinteger nullable

Number of results per page. Defaults to 10 if parameter not sent.

next_tokenstring nullable

A string to get the next page of results if there are more results.

Response

System permissions successfully retrieved.

codestring

Response code.

messagestring

Response message.

next_tokenstring nullable

Pagination token.

Example response

{
  "system_permissions": [
    {
      "id": "perm_019541f3fa0c874fc47b3ae73585b21c",
      "key": "org:read:billing",
      "name": "Read billing details",
      "description": "View plan and update card details"
    }
  ]
}

Changes