Skip to main content
GET
/
api
/
v1
/
roles
/
{role_id}
Typescript (SDK)
import { SyllableSDK } from "syllable-sdk";

const syllableSDK = new SyllableSDK({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const result = await syllableSDK.roles.getById({
    roleId: 324660,
  });

  console.log(result);
}

run();
{
  "name": "<string>",
  "permissions": [
    "<string>"
  ],
  "id": 123,
  "is_system_role": true,
  "last_updated": "2023-11-07T05:31:56Z",
  "last_updated_by": "<string>",
  "description": "Role for users who can fetch and change prompts",
  "last_updated_comments": "Updated to add delete permission"
}

Documentation Index

Fetch the complete documentation index at: https://docs.syllable.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Syllable-API-Key
string
header
required

Path Parameters

​
role_id
integer
required

Response

Successful Response

Information about a role.

​
name
string
required

The name of the role.

Example:

"Prompt Engineer"

​
permissions
string[]
required

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

Example:
[
  "prompts_read",
  "prompts_write",
  "prompts_delete"
]
​
id
integer
required

The internal ID of the role.

Example:

1

​
is_system_role
boolean
required

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

Example:

false

​
last_updated
string<date-time>
required

The timestamp of the most recent update to the role

​
last_updated_by
string
required

The email of the user who last updated the role

Example:

"user@email.com"

​
description
string | null

The description of the role.

Example:

"Role for users who can fetch and change prompts"

​
last_updated_comments
string | null

Comments for the most recent edit to the role.

Example:

"Updated to add delete permission"