ASasksyllable
roles

List Roles

List the existing roles.

get/api/v1/roles/

Request

  • Base URL
    https://api.syllable.cloud
  • URL
    https://api.syllable.cloud/api/v1/roles/
  • Auth
    API key in header Syllable-API-Key

Query parameters

pageinteger nullable

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

limitinteger

The maximum number of items to return

Example:25
search_fieldsRoleProperties[]

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

search_field_valuesstring[]

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

order_by'name' | 'description' | 'updated_at' | 'last_updated_by'

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

The field whose value should be used to order the results

order_by_direction'asc' | 'desc'

The direction in which to order list results, either ascending or descending.

The direction in which to order the results

fieldsRoleProperties[] nullable

The fields to include in the response

start_datetimestring nullable

The start datetime for filtering results

Example:2023-01-01T00:00:00Z
end_datetimestring nullable

The end datetime for filtering results

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

Response

Successful Response

pageinteger required

The page number of the results (0-based)

page_sizeinteger required

The number of items returned per page

total_pagesinteger nullable

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

total_countinteger nullable

The total number of items returned from the query

Example response

{
  "items": [
    {
      "name": "Prompt Engineer",
      "description": "Role for users who can fetch and change prompts",
      "permissions": [
        "prompts_read",
        "prompts_write",
        "prompts_delete"
      ],
      "id": 1,
      "last_updated_comments": "Updated to add delete permission",
      "last_updated_by": "user@email.com"
    }
  ],
  "page_size": 25,
  "total_pages": 4,
  "total_count": 100
}

Changes

No operation changes recorded.