Plane DocsSign in

Roles overview ​

Roles are the named permission levels a member can hold.

The role object ​

Attributes ​

  • description string

    Free-form description.

  • id string (uuid)

    Unique identifier.

  • is_system boolean

    Whether is system.

  • level integer

    The level.

  • name string

    Display name.

  • namespace string

    The namespace.

  • slug string

    The slug.

  • status string

    The status.

Response200
json
{
  "description": "What this is for.",
  "id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
  "is_system": false,
  "level": 1,
  "name": "Example name",
  "namespace": null,
  "slug": "my-team",
  "status": "active"
}

Endpoints ​

MethodPathDescription
GET/api/v2/workspaces/{slug}/roles/List roles
GET/api/v2/workspaces/{slug}/roles/{pk}/Get a role

Response shaping ​

Every role read accepts ?fields= for sparse responses — see Sparse fields. Errors follow the shared problem+json contract.