Team / Team Roles /

Get team role

Gets details about a specific platform role.

Required permission

Account > Admin > Roles > Read

Path parameters

teamId
string required
ID of the team
roleId
string required
ID of the team role

Response body

{object}
Response object.

data
{object} required
Result data.

id
string required
ID of the role.
pattern
^[A-Za-z0-9-]+$
name
string required
Display name of the role.
description
string
Description of the role.
restrictions
{object} required

enabled
boolean required
Whether project restrictions are enabled.
projects
[array] required
Restricted project IDs.

string

restrictionMode
string
Restriction mode.

createdAt
string
Creation time.
updatedAt
string
Last updated.
permissions
{object} required

teamScope
[array] required
Team-level permissions.

string

projectScope
[array] required
Project-level permissions.

string

API

CLI

JS Client

GET /v1/teams/{teamId}/roles/{roleId}

Example response

200 OK

Details about the team role.

JSON

{
  "data": {
    "id": "developer",
    "name": "Developer",
    "description": "Role for developers.",
    "createdAt": "2021-01-20T11:19:53.175Z",
    "updatedAt": "2021-01-20T11:19:53.175Z"
  }
}