Preview: This section describes a preview feature. Preview features are deemed stable; however, they remain under active development and may be subject to shorter deprecation windows. Preview features are suitable for early adopters in production environments. We release preview features so partners and developers can study, test, and integrate them prior to General Availability (GA).
The Capacity Planning REST API uses Atlassian's standard authentication and authorization mechanisms, served through Stargate.
| Method | Description | Status |
|---|---|---|
| Personal API tokens | Basic auth with email + API token for scripts and automation | Available |
| Service account API tokens | Scoped Bearer tokens for service-to-service integrations | Available |
| OAuth 2.0 | Token-based access with granular scopes for apps | Coming soon |
See Authentication for setup instructions and examples.
All API requests are authorized using the authenticated user's existing site and project permissions — the same checks that apply in the Capacity Planning UI.
See Authorization for details on the permission model and OAuth scopes.
Rate limits are enforced per app per tenant (identified by cloudId):
| Operation | Limit |
|---|---|
| Reads (GET requests) | 300 requests per minute |
| Writes (POST, PUT, DELETE requests) | 60 requests per minute |
When you exceed the rate limit, the API returns 429 Too Many Requests. Back
off and retry after the period indicated in the Retry-After response header.
All errors are returned as RFC 7807 Problem Details
with content type application/problem+json:
1 2{ "type": "https://developer.atlassian.com/cloud/capacity-planning/errors/not-found", "title": "Not Found", "status": 404, "detail": "The requested non-project work item does not exist." }
Rate this page: