Get a permission grant

GET/api/v2/workspaces/{slug}/permissions/grants/{pk}/

Retrieve one grant by id. The grant shows who holds which relation on which resource, any extra or refused permissions, and when it expires.

You need the <resource_type>:manage permission on the resource the grant is for. Otherwise the response is 403. A grant that has expired or been deleted returns 404.

Path parameters

slug:requiredstring

The workspace slug. It appears in your Plane URLs. In https://app.plane.so/my-team/projects/, the slug is my-team.

pk:requiredstring (uuid)

The id of the grant.

Response shaping

fields:optionalstring

Comma-separated list of fields to return. Fields you don't request are left out of the response instead of coming back as null, so a missing key means you didn't ask for it and null means the value is null. id is always included, whether or not you name it.

Pass all to get every requestable field. An unknown field name returns 400 with the list of valid names and the closest match, so a typo is caught instead of being silently ignored.

Requestable here: created_at, expires_at, id, permissions_deny, permissions_grant, relation, resource_id, resource_type, subject_id, subject_type, updated_at.

See Sparse fields.

Scopes

workspaces.permissions:read

Errors

Status	Code	Cause
401	unauthorized	Missing or invalid credentials.
403	forbidden	You can't manage access to the grant's resource, or your token scope doesn't allow this.
404	not_found	No such grant in this workspace, or it has expired or been deleted.
406	not_acceptable	The Accept header asks for a representation the API can't produce.
429	rate_limited	Throttled. Honor the Retry-After header before retrying.

Get a permission grant

curl -X GET \
  "https://api.plane.so/api/v2/workspaces/my-team/permissions/grants/e2f9c4a7-1b8d-4c63-9e05-7a3b6d1f8c94/" \
  -H "X-Api-Key: $PLANE_API_KEY"

import requests

response = requests.get(
    "https://api.plane.so/api/v2/workspaces/my-team/permissions/grants/e2f9c4a7-1b8d-4c63-9e05-7a3b6d1f8c94/",
    headers={"X-Api-Key": "your-api-key"},
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v2/workspaces/my-team/permissions/grants/e2f9c4a7-1b8d-4c63-9e05-7a3b6d1f8c94/",
  {
    headers: {
      "X-Api-Key": "your-api-key",
    },
  },
);
const data = await response.json();

Response200

{
  "id": "e2f9c4a7-1b8d-4c63-9e05-7a3b6d1f8c94",
  "subject_type": "user",
  "subject_id": "a8d3e5f1-6b2c-4e97-8d40-1c5f7a9b3e26",
  "relation": "guest",
  "resource_type": "project",
  "resource_id": "4af68566-94a4-4eb3-94aa-50dc9427067b",
  "permissions_grant": ["workitem:create"],
  "permissions_deny": [],
  "expires_at": "2026-03-31T23:59:59Z",
  "created_at": "2026-01-20T11:05:17.204918Z",
  "updated_at": "2026-01-20T11:05:17.204918Z"
}

Response403

{
  "type": "forbidden",
  "code": "forbidden",
  "detail": "You don't have permission to manage access to this resource."
}