Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.permitcore.io/llms.txt

Use this file to discover all available pages before exploring further.

Status: programmatic API key endpoints ship with the Bucket 2 data-pipeline release (~3 weeks). Until then, manage keys via your account dashboard — keys are issued on signup and rotated via dashboard UI.

​
Draft endpoint catalog

​
POST /v1/keys — Create a key

{
  "name": "production-server",
  "scopes": ["query"]
}
Returns: 
{
  "key": "pk_live_a1b2c3d4...",
  "key_prefix": "pk_live_a1b2",
  "name": "production-server",
  "scopes": ["query"],
  "created_at": "2026-05-24T18:00:00Z"
}
The full key value is returned once at creation. Store it immediately; we don’t display it again.

​
GET /v1/keys — List your keys

Returns metadata for all keys owned by the calling user: 
{
  "keys": [
    {
      "key_prefix": "pk_live_a1b2",
      "name": "production-server",
      "scopes": ["query"],
      "created_at": "2026-05-24T18:00:00Z",
      "last_used_at": "2026-05-24T20:14:00Z"
    }
  ]
}

​
DELETE /v1/keys/{prefix} — Revoke a key

Revokes the key. Subsequent requests with this key return 401.

​
GET /v1/keys/{prefix}/usage — Per-key usage

{
  "key_prefix": "pk_live_a1b2",
  "period": "2026-05",
  "request_count": 4823,
  "quota": 100000,
  "percent_used": 4.823,
  "throttled_24h": 0,
  "recent_requests": [
    { "timestamp": "2026-05-24T20:14:00Z", "endpoint": "/v1/jurisdictions/nyc/cohorts/distribution", "status": 200 }
  ]
}

​
Scopes (future)

ScopeGrants
queryRead access to all GET endpoints on this account’s tier
adminManage keys (POST / DELETE on /v1/keys); usually not needed for application keys

​
Until then