Public REST API

Feature Upvote has a public REST API that allows you to use core functionality:

• View suggestions
• Create and update suggestions
• View comments
• Vote and “unvote” for a suggestion
• Get notifications via a webhook of new suggestions and comments

In this article

• Response bodies are in JSON
• API key
• API URL
• Authentication
• Pagination
• Rate limits

Endpoints

• Verify your key is valid
• List your account’s boards
• Show one specific board
• List a board’s suggestions
• Show one specific suggestion
• Search for suggestions
• List a suggestion’s comments
• Show one specific comment
• List a board’s statuses
• Create a new suggestion
• Update an existing suggestion
• List a suggestion’s votes
• Vote for a suggestion
• Remove a vote
• Subscribe to a webhook for new or changed suggestions and comments
• Unsubscribe from a webhook
• List webhooks

Response bodies are in JSON

All results are in JSON. If you don’t get a  valid JSON response body, it’s probably one of these problems:

1. The URL is wrong
2. Cloudflare, who protects our website from attacks, has incorrectly identified your usage as malicious. Let us know and we’ll investigate

API key

To use this API, you’ll need a API key. You’ll find your API key in your Feature Upvote dashboard as follows:

1. Click on the user icon in the top-right hand corner
2. From the drop-down menu, select Account
3. Go to the Developer tab

Or, if you are currently signed in to your Feature Upvote account, click here.

REST API URL

All endpoints start with https://api.featureupvote.com/api/v1/               

Authentication

All requests must be authenticated using the HTTP Bearer header:

curl -X GET "https://api.featureupvote.com/api/v1/verify" -H "Authorization: Bearer <api_key>"               

Pagination

Three response headers show you information about pagination:

• Pagination-Count - the full number of results available.
• Pagination-Limit - the maximum number of results returned per request. Defaults to 10.
• Pagination-Offset - how many results were skipped in this response. Defaults to 0.

If you are familiar with SQL, you can think of the Pagination-Limit and Pagination-Offset parameters as analagous to SQL’s LIMIT and OFFSET keywords.

Set limit and offset

You can override these using query parameters:

• limit               query parameter, defaults to 10
• offset               query parameter, defaults to 0

eg

https://api.featureupvote.com/api/v1/boards?limit=20&offset=40              

Rate limits

Our public REST API has generous rate limits, but they do exist as part of our protections from external attack. If you find your API usage is impacted by our rate limits, get in touch and tell us your use case. We might be able to make an exception.

Endpoints

Verify your key is valid

A great starting point:

URL: https://api.featureupvote.com/api/v1/verify               

Method: GET

Example success response:

{
  "result": "success",
  "message": "This API key is valid and active.",
  "accountId": 1
}

Example error responses:

{
  "error": {
    "message": "Invalid API Key provided: ****efer",
    "type": "invalid_request_error"
  }
}

{
  "error": {
    "message": "You did not provide an API key. You need to provide your API key in the Authorization header using a Bearer token (e.g. Authorization: Bearer [YOUR_API_KEY])",
    "type": "invalid_request_error"
  }
}

List your account’s boards

URL: https://api.featureupvote.com/api/v1/boards               

Method: GET

Show one specific board

URL: https://api.featureupvote.com/api/v1/boards/{boardRef}               

Method: GET

List a board’s suggestions

URL:https://api.featureupvote.com/api/v1/boards/{boardRef}/suggestions              

Method: GET

Show one specific suggestion

URL: https://api.featureupvote.com/api/v1/boards/{boardRef}/suggestions/{suggestionId}   

Method: GET

Search for suggestions

URL:https://api.featureupvote.com/api/v1/boards/{boardRef}/search?q={search+terms}            

Method: GET

Separate multiple search terms with the +             sign.

By default, you’ll receive at most 20 results. Use the limit            query parameter to change this. The maximum allowed value for limit             is 250.

eg

https://api.featureupvote.com/api/v1/boards/{boardRef}/search?q=potion+upgrade&limit=50            

List a suggestion’s comments

URL:https://api.featureupvote.com/api/v1/boards/{boardRef}/suggestions/{suggestionId}/comments              

Method: GET

Show one specific comment

URL: https://api.featureupvote.com/api/v1/boards/{boardRef}/suggestions/{suggestionId}/comments/{commentId}  

Method: GET

List a board’s statuses

URL:https://api.featureupvote.com/api/v1/boards/{boardRef}/statuses            

Method: GET

Returns a list of valid statuses for your board, including the short codes (aka statusRef           ) needed to create or update a suggestion if you don’t want to accept the default “Awaiting approval” status.

The result is an array of JSON objects, each representing one status.

eg

{
  "id": 1360,
  "statusRef": "awaitingapproval",
  "description": "Awaiting approval"
} 

In this case, the short code is awaitingapproval           .

Create a new suggestion

URL: https://api.featureupvote.com/api/v1/boards/{boardRef}/suggestions            

Method: POST

Returns the newly created suggestion in the response body.

The request body must be a JSON object, with the following properties:

Update an existing suggestion

URL: https://api.featureupvote.com/api/v1/boards/{boardRef}/suggestions/{suggestionId}            

Method: POST

Returns the newly created suggestion in the response body.

A field will only be updated if it is present in the request.

The request body must be a JSON object, with the following properties:

List a suggestion’s votes

URL:https://api.featureupvote.com/api/v1/boards/{boardRef}/suggestions/{suggestionId}/votes     

Method: GET

Vote for a suggestion

URL:https://api.featureupvote.com/api/v1/boards/{boardRef}/suggestions/{suggestionId}/votes     

Method: POST

Returns the newly created vote in the response body.

An attempt is made to find an existing contributor with either the remoteUserId, or with the combination of name and email. If found, the vote is assigned to the existing contributor. Otherwise a new contributor is created.

The request body must be a JSON object, with the following properties:

Remove a vote

URL:https://api.featureupvote.com/api/v1/boards/{boardRef}/suggestions/{suggestionId}/votes/{upvoteId}     

Method: DELETE

Removes the vote with the specified upvoteId      . If not found, a helpful error message is returned.

The vote must belong to the specified suggestion.

Create a webhook endpoint for new or changed suggestions and comments

URL: https://api.featureupvote.com/api/v1/boards/{boardRef}/hooks           

Method: POST

Returns info about the newly created webhook in the response body.

The request body must be a JSON object, with the following properties:

Delete a webhook endpoint

URL: https://api.featureupvote.com/api/v1/boards/{boardRef}/hooks/unsubscribe           

Method: POST

The request body must be a JSON object, with the following properties:

List webhooks

URL: https://api.featureupvote.com/api/v1/boards/{boardRef}/hooks           

Method: GET

Returns a list of all webhooks currently registered for the specified board.