# Your whole workspace, over a REST API

> Read and write posts, votes, changelog, help center articles, conversations and tickets over a REST API. Scoped keys and an OpenAPI reference included.

Source: https://quackback.io/integrations/api

Build dashboards, sync your data warehouse or connect internal tools. The API covers feedback, the changelog, the help center, support conversations, tickets and your status page.

Included in Quackback Cloud on every plan, including Free, and in every self-hosted install.

## Read from Quackback

From Quackback to REST API:

- Posts, votes, comments, boards and roadmaps
- Changelog entries and help center articles
- Users, companies, conversations and tickets

## Write to Quackback

From REST API into Quackback:

- Create posts and vote on behalf of customers
- Publish changelog entries and articles
- Update your status page from monitoring tools

## What it does

- **Scoped keys**: Give each key read, or read and write, per area of the workspace.
- **OpenAPI reference**: Every workspace serves its own interactive reference at /api/v1/docs.
- **Predictable JSON**: Cursor pagination and one error shape across every endpoint.

## Set it up

1. **Create a key**: In Settings, open Developers and create a key with the access it needs.
2. **Send it as a Bearer token**: Call https://your-workspace/api/v1 with the key in the Authorization header.
3. **Browse the reference**: Open /api/v1/docs on your workspace to try every endpoint.

Setup guide: https://feedback.quackback.io/hc/en/articles/147-api-overview

## Frequently asked questions

### Is there an OpenAPI spec for the Quackback API?

Yes. Every workspace serves an interactive reference at /api/v1/docs and the spec at /api/v1/openapi/json, always matching the version you run.

### Is there a rate limit on the API?

Yes. Requests are counted per minute. On Quackback Cloud the limit depends on your plan, and self-hosted installs allow 100 requests a minute by default. Go over and you get a 429 response with a Retry-After header that says when to try again.

Start a free trial: https://app.quackback.io/signup?plan=pro&from=markdown
