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_keyKey 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.
| Permission | Description |
|---|---|
requests:read | List and retrieve feature requests |
requests:write | Create, update, and delete feature requests |
roadmap:read | List and retrieve roadmap items |
roadmap:write | Create, update, and delete roadmap items |
tasks:read | List and retrieve tasks |
tasks:write | Create, update, and delete tasks |
projects:read | List and retrieve projects |
comments:read | List and retrieve comments |
comments:write | Create comments on feature requests |
okrs:read | List objectives and key results |
okrs:write | Update 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."
}
}