Skip to content

Mint an org API key

POST
/orgs/{orgId}/api-keys

Creates an org key (ptl_o_…) — a service identity with power admin minus destructive:
it can manage boards, cards, labels, templates, and integrations, but can never delete the org,
touch billing, change membership, or manage keys. Admin+ only. Secret shown once.

Authorizations

bearer
Type
HTTP (bearer)

Parameters

Path Parameters

orgId*
Type
string
Required

Request Body

application/json
JSON
{
  
"name": "CI reporter",
  
"read_only": false
}

Responses

Created — includes the one-time secret.

application/json
JSON
{
  
"id": "018f0a5e-1c2b-7e3a-9b4c-0000000f0001",
  
"name": "CLI · device login",
  
"kind": "string",
  
"prefix": "ptl_u_0727c24e…",
  
"read_only": true,
  
"created_at": "string",
  
"last_used_at": "string",
  
"secret": "ptl_u_0727c24e_9f83a1c0d24e7b…"
}

Playground

Authorization
Variables
Key
Value
Body

Samples

Powered by VitePress OpenAPI

One vocabulary, every door.