Stop copying feedback by hand. Let your own code do it.
Read the board, file requests, cast votes and read the figures behind each one. Twenty one endpoints, and every one is listed.
14 day trial. Card up front, charged after it ends.
If it is on your board, your code can reach it.
Boards, requests, votes, comments, the changelog and voters each have their own endpoints, and so do the figures behind them. That makes 21 in all, and three need no key.
The list is short on purpose. If an action is not on it, the API does not do it.
Give each service its own key. Lose one, replace one.
Make a key on the share page and copy it right then, because it is shown once. A project holds up to five keys.
Every write route is checked apart from every read route, so reading is never a back door to writing.
The money behind a request stays on your server.
The revenue endpoint refuses an embed key, because an embed key lives in a public page. Call it from your backend with a server key.
Visitors can vote and comment on your pages, while the figures behind each request stay out of their reach.
Only need a board on a web page? Skip the API.
Widgets draw the board inside your site on any plan with a public embed key. The API is for your own backend.
Reach for it when your code should read or write the board, not when a visitor should see it.
See the widgets for your own siteWhat your code gets from the board
Requests filed by your own code
A request your code files lands on the same board as everyone else's, ready to be voted on.
Votes cast from inside your product
Sign a viewer in and cast a vote for them, so they never leave your own screens.
Voters and figures in your reports
Read who voted and what each voter is worth, then put it in the dashboards you already use.
A full list with nothing hidden
The endpoint list is complete. What is not on it, the API does not do.
Your first call, in three steps
Make a key on the share page
Open the share page and make a key. Copy it right away, because it is shown once.
Call an endpoint from your server
Send a request to any endpoint with the key. Reads, writes and votes each have their own route.
Check the change on your board
Open the board and look. Requests you file and votes you cast show up like any other.
What you may ask before you build
Which plan includes the API?
Pro, at $39/mo. Lite has no API.
How many keys can one project have?
Five. Each is shown once, when you make it, so copy it at that moment.
Can I call the API from a web page?
Not the revenue endpoint, which refuses an embed key. Use a server key on your backend instead.
Do I need a key to read the board?
Three of the 21 endpoints are open and need no key. The other 18 do.
Can I sign my own users in through it?
Yes. One endpoint signs a viewer in, so the person who votes is someone you already know.
Is there an SDK?
For iOS and macOS there is a Swift package on every plan. The API itself is plain REST, so any language can call it.
What you should know first
- The API is a Pro feature. Lite has none.
- It is a REST API for your own backend. Web pages use the widgets, which take a public embed key.
Build on the board
On Pro at $39/mo. Both plans start with a 14 day trial of Pro, and a card is asked at signup.