REST API

The REST API is at /api/v1; interactive documentation at /api/v1/docs. Authenticate with a personal access token:

TOKEN=spk_…
curl -H "Authorization: Bearer $TOKEN" https://chips.example.com/api/v1/projects
curl -H "Authorization: Bearer $TOKEN" -H "Content-Type: text/csv" --data-binary @stories.csv \
     https://chips.example.com/api/v1/rooms/ROOM_ID/stories/csv
curl -H "Authorization: Bearer $TOKEN" -o results.csv https://chips.example.com/api/v1/rooms/ROOM_ID/results

Projects, rooms, stories (add, change, attributes), notes, sessions and results, recordings, Jira preview and update, and for administrators users and the activity log. Permissions are the same as on the pages; read-only tokens can only read. GET /api/v1/health shows the version.

For scripts, reports and other tools. Create a token on the Account page (read-only or read and write, with an expiry); it is shown once. Send it like a Jira personal access token:

TOKEN=spk_…
curl -H "Authorization: Bearer $TOKEN" https://poker.example.com/api/v1/projects
curl -H "Authorization: Bearer $TOKEN" -H "Content-Type: text/csv" --data-binary @stories.csv \
     https://poker.example.com/api/v1/rooms/<room id>/stories/csv
curl -H "Authorization: Bearer $TOKEN" -o results.csv \
     https://poker.example.com/api/v1/rooms/<room id>/results

Interactive documentation: /api/v1/docs. Endpoints: /me; projects (list, create, rename, archive); rooms (create in a project, read with backlog and final estimates, results CSV, sessions); stories (add as JSON or CSV, change — incl. attributes); Jira (preview, update); notes (read, add); sessions (list, detail with every vote, results CSV); /users for administrators. Permissions are the same as on the web pages. Tokens are stored only as hashes; they can be revoked by their owner or an administrator, and the API can be turned off in Admin → Settings.