Access to the Capacity Planning REST API is controlled by two layers: user permissions (always enforced) and OAuth scopes (enforced when using OAuth 2.0 authentication).
All API requests — regardless of authentication method — require the authenticated user to have the appropriate Jira site permissions for capacity planning features. The API enforces the same permission checks as the Capacity Planning UI — a user cannot access or modify data they wouldn't be able to see in the product.
When using OAuth 2.0, each request must carry a token with the appropriate scope. Each resource has a separate read and write scope.
| Scope | Permits |
|---|---|
read:contribution:capacity-planning | Read contributions (time allocations) |
write:contribution:capacity-planning | Create, update, and clear contributions |
read:contributor-work-association:capacity-planning | Read assignment links between people and work |
write:contributor-work-association:capacity-planning | Create and delete assignment links |
read:non-project-work:capacity-planning | Read non-project work items |
write:non-project-work:capacity-planning | Create, update, and delete non-project work items |
Regardless of the API token type, the request acts as the authenticated user with their existing site and project permissions.
| Endpoint | Method | Required scope (OAuth only) |
|---|---|---|
/v1/contributions | GET | read:contribution:capacity-planning |
/v1/contributions | POST | write:contribution:capacity-planning |
/v1/contributions:clear | POST | write:contribution:capacity-planning |
/v1/contributor-work-associations | POST | write:contributor-work-association:capacity-planning |
/v1/contributor-work-associations/by-contributor | GET | read:contributor-work-association:capacity-planning |
/v1/contributor-work-associations/by-work | GET | read:contributor-work-association:capacity-planning |
/v1/contributor-work-associations:delete | POST | write:contributor-work-association:capacity-planning |
/v1/non-project-work-items | GET | read:non-project-work:capacity-planning |
/v1/non-project-work-items | POST | write:non-project-work:capacity-planning |
/v1/non-project-work-items/{id} | GET | read:non-project-work:capacity-planning |
/v1/non-project-work-items/{id} | PUT | write:non-project-work:capacity-planning |
Rate this page: