Skip to content

REST API

Build on the Quackback API

A complete REST API with OpenAPI documentation. Read and write feedback data programmatically, build custom dashboards, and automate any workflow.

Star on GitHub76

What it does

Every resource, every operation. Nothing hidden behind a paywall.

01 / 04

Full CRUD operations

Create, read, update, and delete all resources. Posts, comments, votes, boards, users, and tags are all accessible via the API. Batch operations for bulk updates, admin operations, and board and tag management.

02 / 04

OpenAPI documentation

Interactive API docs powered by OpenAPI 3.0. Try endpoints directly in your browser and generate client libraries for any language. Interactive Swagger UI at /api/v1/docs with request and response examples.

03 / 04

Authentication

Secure API access with API keys or OAuth tokens. Scoped permissions let you control exactly what each key can access. Key rotation without downtime and OAuth 2.0 token support built in.

04 / 04

Rate limiting and pagination

Clear rate limit headers and cursor-based pagination let you build integrations that handle large datasets without surprises. Configurable page sizes, generous defaults, and configurable for self-hosted.

Example

Predictable JSON, everywhere

Every endpoint returns JSON with a consistent schema. Pagination, errors, and metadata follow the same rules so you can write one client and be done.

Terminal
GET /api/v1/posts?sort=votes&limit=5

// Response
{
  "data": [{
    "id": "post_01",
    "title": "Dark mode support",
    "votes": 47,
    "status": "planned"
  }]
}

Authentication

Scoped tokens, secure by default

Generate API keys from the admin panel and authenticate with a single header. Scoped permissions let you grant read-only or full access per key, and rotation happens without downtime.

  • Token-based authentication with scoped keys
  • JSON responses with predictable schema
  • Cursor-based pagination for large datasets
  • OpenAPI 3.0 spec for client generation
curl
curl https://quackback.io/api/v1/posts \
  -H "Authorization: Bearer $QB_TOKEN" \
  -H "Content-Type: application/json"

FAQ

Frequently asked questions

Is the API included in the free plan?

Yes. The full REST API is included in every Quackback deployment, including self-hosted. There is no premium tier or separate API pricing. Every endpoint is available from day one.

What authentication does the API use?

The API uses token-based authentication. Generate API keys from the admin panel and include them in the Authorization header. Tokens support scoped permissions for read-only or full access.

Can I build custom integrations?

Yes. The API covers all CRUD operations for posts, votes, comments, statuses, boards, and users. Build custom dashboards, sync with internal tools, or automate workflows. OpenAPI documentation is included for code generation.

Start building with the API

Deploy anywhere in minutes. Free and open source.

Get started