The Shaire API

Read and write a workspace from a script, a CI job or an assistant, with a token you scope and revoke yourself.

Every endpoint takes a personal access token in an Authorization header. There is no OAuth flow, no client registration, and no x-workspace-id header: a token names its workspace when you mint it, so a request carries one credential and nothing else.

curl https://api.shairelabs.com/api/tickets \
  -H "Authorization: Bearer $SHAIRE_TOKEN"

That is the whole shape of a request. Quickstart turns it into a working one in about two minutes.

What you can reach

152 endpoints across 30 resources, listed in the reference and generated from the same document the server is checked against. Tickets, lists and folders; pages and their version history; comments, activity and notifications; time entries; search; the six reports; and the workspace vocabulary a client needs to render any of it.

Routes in the reference are stable. A breaking change to one gets a new path rather than an edit, so a client written against a documented endpoint keeps working. New fields do appear, so parse responses in a way that tolerates them.

Getting notified

GET /api/activity/feed returns what changed across the workspace in one request, which is what a job on a timer should read before fetching anything else. GET /api/notifications covers events addressed to one person.

For push rather than poll, a workspace admin registers an endpoint under Settings → Webhooks in the app. Deliveries are signed, retried and logged, and they describe the change rather than carrying the whole object, so a receiver reads the type and id and then calls the API for the detail.

Where to go next

Quickstart if you want a working request now. Authentication and Scopes if you are deciding what a token should be allowed to do. Errors before you write the first retry.