Boards API reference

This is the reference for the Boards endpoints of the Quackback REST API: every endpoint, its parameters, request fields and response fields. It is generated from the API's OpenAPI description, so it matches what the API accepts.

All paths are relative to /api/v1 on your workspace's address (for example https://feedback.example.com/api/v1). Authenticate with an API key in the Authorization: Bearer qb_... header. For keys, errors, pagination and rate limits, see API overview. Every workspace also serves an interactive reference at /api/v1/docs.

Endpoints

• GET /boards: List boards
• POST /boards: Create a board
• GET /boards/{boardId}: Get a board
• PATCH /boards/{boardId}: Update a board
• DELETE /boards/{boardId}: Delete a board

List boards

GET /api/v1/boards

Returns all boards in the workspace

Response 200: returns id, name, slug, description, audience, postCount, createdAt, updatedAt.

Create a board

POST /api/v1/boards

Create a new feedback board

Request body

Response 201: returns id, name, slug, description, audience, createdAt, updatedAt.

Get a board

GET /api/v1/boards/{boardId}

Get a single board by ID

Parameters

Response 200: returns id, name, slug, description, audience, settings, createdAt, updatedAt.

Update a board

PATCH /api/v1/boards/{boardId}

Update an existing board

Parameters

Request body

Response 200: returns id, name, slug, description, audience, settings, createdAt, updatedAt.

Delete a board

DELETE /api/v1/boards/{boardId}

Delete a board by ID

Parameters