API Reference
API Reference

List Permissions

Get all available permissions in the system.

GET/api/v1/permissions/

Authentication

Syllable-API-Keyrequired

Send Syllable-API-Key in the header.

Need a credential? Create or manage an API token in the Syllable Console.

Parameters

This endpoint has no declared parameters.

Responses

200Successful Response

application/json

response PermissionGroupResponse[] required
Item schema
itemsPermissionGroupResponserequired

Information about a group of permissions related to the same feature.

3 fields
namestringrequired

Name of the permission group

descriptionstringrequired

Description of the permission group

permissionsPermissionResponse[]required

Permissions in the group

Item schema
itemsPermissionResponserequired

Information about a permission.

3 fields
namestringrequired

Name of the permission

display_namestringrequired

Display name of the permission

descriptionstring | nulloptional

Description of the permission

Response example
[
  {
    "name": "string",
    "description": "string",
    "permissions": [
      {
        "name": "string",
        "display_name": "string",
        "description": "string"
      }
    ]
  }
]