Skip to main content
GET
https://api.plane.com/v1
/
roles
/
{id}
Get a role
curl --request GET \
  --url https://api.plane.com/v1/roles/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "wrl_cNqYX2J3s9bI2Aa",
  "worker": "wr_5yMmVvd6Cz7Ptx",
  "title": "Software Engineer",
  "responsibilities": "Design, develop, and maintain software applications.",
  "level": 3,
  "created": "2024-01-15T00:00:00Z"
}

Parameters

id
string
required
The ID of a role in your Plane workspace.

Returns

Returns a role if a valid identifier was provided, and returns an error otherwise.
{
  "id": "wrl_cNqYX2J3s9bI2Aa",
  "worker": "wr_5yMmVvd6Cz7Ptx",
  "title": "Software Engineer",
  "responsibilities": "Design, develop, and maintain software applications.",
  "level": 3,
  "created": "2024-01-15T00:00:00Z"
}