Authentication

All API requests require a valid API key passed as a Bearer token.

Bearer Token

Include your API key in the Authorization header of every request.

Authorization: Bearer pk_live_your_api_key

Key Format

API keys use the prefix pk_live_ followed by a random string. Keys are generated in your dashboard under Settings → API Keys.

Permissions

Each API key can be scoped with the following permissions.

PermissionDescription
requests:readList and retrieve feature requests
requests:writeCreate, update, and delete feature requests
roadmap:readList and retrieve roadmap items
roadmap:writeCreate, update, and delete roadmap items
tasks:readList and retrieve tasks
tasks:writeCreate, update, and delete tasks
projects:readList and retrieve projects
comments:readList and retrieve comments
comments:writeCreate comments on feature requests
okrs:readList objectives and key results
okrs:writeUpdate key result progress

Error Responses

Missing API Key

401 Unauthorized
{
  "error": {
    "code": "unauthorized",
    "message": "Missing or invalid Authorization header."
  }
}

Invalid API Key

401 Unauthorized
{
  "error": {
    "code": "unauthorized",
    "message": "The provided API key is invalid or has been revoked."
  }
}