Introduction

The FeatureOS API enables you to build custom applications to collect feedback, publish roadmaps, and announce new features to your users. It also provides access to your boards, posts, votes, comments, changelogs, knowledge base, customers, teams, and more.

If you are already signed in with your FeatureOS account, the code samples on these pages use your real API keys and account-specific values. Enjoy building new integrations for your workflow with the FeatureOS API.

Base URL

All requests are made to the versioned v3 base URL over HTTPS:

https://api.featureos.app/api/v3

Note — All API requests must be made over HTTPS. Requests made over plain HTTP are not honored by our servers.

Quick start

Authenticate with your organization API key in the API-KEY header and call any endpoint:

curl https://api.featureos.app/api/v3/buckets \
  -H 'API-KEY: hn_your_api_key'

From there:

• Authentication — how to generate and use API keys, and per-user SSO tokens.
• Errors — status codes and application error codes.
• API Reference — the full interactive REST reference with a try-it playground.
• Webhooks — receive real-time callbacks when posts and changelogs change.

API versioning

The FeatureOS API is currently on version 3 (v3). We only make backwards-compatible changes to a published version, and we announce any breaking changes in advance.

Rate limiting

The API is rate limited to 100 requests per minute per API key. If you exceed this limit you receive a 429 Too Many Requests response — slow down and retry after a brief pause.

Requesting new APIs

We are on a mission to increase the number of customer-first companies in the world, and sharing our APIs is a core part of that. If an endpoint you need is missing, let us know on our public feedback board.