API Reference
API Reference

List Roles

List the existing roles.

GET/api/v1/roles/

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

Query parameters

page integer | null query optional

The page number from which to start (0-based)

Default 0Minimum 0Example 0
limit integer query optional

The maximum number of items to return

Default 25Minimum 0Example 25
search_fields enum<string>[] query optional

String names of fields to search. Correspond by index to search field values

Default []Example name
Item schema
itemsenum<string>required

Names of role fields supported for filtering/sorting on list endpoint.

Allowed values ["name","description","updated_at","last_updated_by"]
search_field_values string[] query optional

Values of fields to search. Correspond by index to search fields. Unless field name contains "list", an individual search field value cannot be a list

Default []Example Some Object Name
Item schema
itemsstringrequired
order_by enum<string> | null query optional

The field whose value should be used to order the results

Allowed values ["name","description","updated_at","last_updated_by"]Example name
order_by_direction enum<string> | null query optional

The direction in which to order the results

Allowed values ["asc","desc"]
fields enum<string>[] | null query optional

The fields to include in the response

Default []Example []
Item schema
itemsenum<string>required

Names of role fields supported for filtering/sorting on list endpoint.

Allowed values ["name","description","updated_at","last_updated_by"]
start_datetime string | null query optional

The start datetime for filtering results

Example 2023-01-01T00:00:00Z
end_datetime string | null query optional

The end datetime for filtering results

Example 2024-01-01T00:00:00Z

Responses

200Successful Response

application/json

response ListResponse_RoleResponse_ required
5 fields
itemsRoleResponse[]required

List of items returned from the query

Item schema
itemsRoleResponserequired

Information about a role.

8 fields
namestringrequired

The name of the role.

descriptionstring | nulloptional

The description of the role.

permissionsstring[]required

The permissions associated with the role. Available permissions can be found by calling GET /permissions.

Item schema
itemsstringrequired
idintegerrequired

The internal ID of the role.

last_updated_commentsstring | nulloptional

Comments for the most recent edit to the role.

is_system_rolebooleanrequired

Whether this is a built-in system role that cannot be updated or deleted

last_updatedstring (date-time)required

The timestamp of the most recent update to the role

last_updated_bystringrequired

The email of the user who last updated the role

pageintegerrequired

The page number of the results (0-based)

page_sizeintegerrequired

The number of items returned per page

total_pagesinteger | nulloptional

The total number of pages of results given the indicated page size

total_countinteger | nulloptional

The total number of items returned from the query

Response example
{
  "items": [
    {
      "name": "string",
      "description": "string",
      "permissions": [
        "string"
      ],
      "id": 0,
      "last_updated_comments": "string",
      "is_system_role": true,
      "last_updated": "string",
      "last_updated_by": "string"
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_pages": "string",
  "total_count": "string"
}
422Validation Error

application/json

response HTTPValidationError required
1 field
detailValidationError[]optional
Item schema
itemsValidationErrorrequired
3 fields
locstring | integer[]required
Item schema
itemsstring | integerrequired
2 options
Option 1stringrequired
Option 2integerrequired
msgstringrequired
typestringrequired
Response example
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}