Skip to content

Permissions overview ​

These endpoints report what the calling principal is actually allowed to do.

The permission object ​

Attributes ​

  • permission_grants array of string

    The permission grants.

  • relation string

    The relation.

Response200
json
{
  "permission_grants": ["example"],
  "relation": "example"
}

Endpoints ​

MethodPathDescription
GET/api/v2/workspaces/{slug}/projects/{project_id}/permissions/me/Get your effective project permissions
GET/api/v2/workspaces/{slug}/permissions/me/Get your effective workspace permissions

Response shaping ​

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