Skip to content

REST API

The REST API offers the same operations as the MCP server, as plain HTTP and JSON. The full list is in the OpenAPI document at /api/v1/openapi.json.

Create a personal access token in Settings → API & apps. Pick:

  • Permissions: reading is always on; add tasks:write, docs:write, submit or invoices:draft as needed.
  • Studios: all of yours, or just one.
  • Expiry: 30 days, 90 days, a year, or never.

The token is shown once. Baseplate only keeps a fingerprint, so a lost token can’t be recovered: revoke it and make a new one.

Terminal window
curl https://{your domain}/api/v1/studios/kotzuki/projects/OBBY/tasks?sprint=active \
-H "Authorization: Bearer bp_pat_…"
Terminal window
curl -X POST https://{your domain}/api/v1/studios/kotzuki/projects/OBBY/tasks \
-H "Authorization: Bearer bp_pat_…" \
-H "Content-Type: application/json" \
-d '{"title": "Fix the lava stage", "priority": "high"}'

Inputs go in the query string for GET and in a JSON body otherwise.

Errors come back as { "error": { "status": 403, "message": "…" } } with the matching HTTP status. Each token can make 120 requests a minute; past that you get 429 with Retry-After.