AltaClario
OpenAPI spec

Developer API

A read-only REST API to pull your workspace’s issues, sprints, and velocity into scripts, notebooks, or BI tools. Stable under /api/v1. The full machine-readable description lives at /api/v1/openapi.json.

Authentication

Create a token in Settings → API Tokens (admins only; the raw value is shown once). Send it as a Bearer token:

curl https://altaclario.com/api/v1/me \
  -H "Authorization: Bearer da_xxxxxx_your_secret_here"

Endpoints

MethodPathDescription
GET/api/v1/meToken sanity check — returns your org + the token's scopes.
GET/api/v1/issuesList issues. Params: projectKeys, maxResults (≤500), statusCategory.
GET/api/v1/sprintsList sprints with state, dates, and goal.
GET/api/v1/metrics/velocityVelocity history. Param: limit (≤24).

Examples

# Issues in progress, capped at 50
curl "https://altaclario.com/api/v1/issues?statusCategory=in_progress&maxResults=50" \
  -H "Authorization: Bearer $ALTACLARIO_TOKEN"

# Last 12 sprints of velocity
curl "https://altaclario.com/api/v1/metrics/velocity?limit=12" \
  -H "Authorization: Bearer $ALTACLARIO_TOKEN"

Notes

  • All endpoints are read-only in v1. Tokens need the read scope.
  • Responses are provider-agnostic — the same shape whether the workspace is on Jira or Azure DevOps.
  • Rate-limited per IP; back off on 429 and respect Retry-After.
  • Provider errors surface as 502 with an error field.