Your board has an API. Public ideas and the roadmap need no key, so your product or website can read them. Posting and changing ideas needs one.
Your site describes the whole API at /api/docs, and for an AI at
/llms.txt.
Read without a key
GET /api/v1/ideas?status=planned&sort=top
GET /api/v1/ideas/{id}
GET /api/v1/ideas/{id}/updates
GET /api/v1/roadmap
The list takes the board's filters: status, category, q, sort
(top, new or trending), page and per_page (at most 100). The
roadmap answers its three columns, and Not found while the roadmap page
is off. Statuses are ids, like planned or progress, never words in a
language.
Make a key
- Open Integrations, then API keys, and choose New API key.
- Give it a Name and tick only the Scopes it needs:
ideas:read, to read every idea, those waiting for review and in the trash included.ideas:write, to post, edit, answer, merge and delete ideas.voters:read, to read an idea's voters and their addresses.
- Choose Create API key and copy the key. It is shown once.
A key acts as the member who made it and can do only what that member may. It goes in each request:
Authorization: Bearer sk_live_...
Post an idea, then an update
POST /api/v1/ideas
{"title": "Dark mode", "body": "For late nights.", "status": "planned"}
POST /api/v1/ideas/{id}/updates
{"status": "shipped", "body": "Out today.", "email": true}
An update sets the status, as in the admin, and with "email": true it
emails the voters. A status cannot be changed with PUT.
Votes are never cast through the API: a vote is a person's own, confirmed by their email.
Hear about changes
Under Integrations, Webhooks, choose the events to send: An idea is posted, An idea's status changes, An idea is merged into another and An idea is moved to the trash.