1. Docs
  2. API Reference
  3. Get a permission

Get a permission

GET/api/v1/permissions/{id}

Authentication

  • Bearer Token Authorization

    JWT access token

  • API Key X-API-Key

    API key for management-tier access

Path Parameters

Name Required Type Description
idRequiredstring

Code samples

cURLJavaScriptPythonGo
curl -X GET "https://api.canopy.dev/api/v1/permissions/value" \
  -H "X-API-Key: $CANOPY_API_KEY"

Responses

200 Permission returned
{
  "id": "string",
  "application_id": "string",
  "key": "string",
  "description": "string",
  "category": "string",
  "source": "system",
  "created_at": "2026-04-20T12:00:00.000Z",
  "version": 0
}

application/json

  • idstring*
  • application_idstring*
  • keystring*
  • descriptionstring
  • categorystring
  • sourceenum: "system" | "custom"*
  • created_atstring (date-time)*
  • versionnumber*

    Optimistic-lock version. Send back as the `If-Match` header when updating to detect concurrent edits.

401 Invalid or expired token
403 This token is not authorized for this endpoint (wrong principal type — e.g., admin token on identity-only endpoint, or vice versa)

Returned object

On this page

Related endpoints

GETList permission catalog
POSTRegister new permission(s)
PATCHUpdate permission metadata
DELETERemove a permission
POSTEvaluate authorization
POSTBulk evaluate authorization