Statuses API reference
Statuses endpoints of the Quackback REST API: paths, parameters, request fields and responses.
This is the reference for the Statuses 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 /statuses: List statusesPOST /statuses: Create a statusGET /statuses/{statusId}: Get a statusPATCH /statuses/{statusId}: Update a statusDELETE /statuses/{statusId}: Delete a status
List statuses
GET /api/v1/statuses
Returns all statuses in the workspace, ordered by category and position
Response 200: returns id, name, slug, color, category, position, showOnRoadmap, isDefault, createdAt.
Create a status
POST /api/v1/statuses
Create a new post status
Request body
Field | Type | Required | Description |
|---|---|---|---|
| string | Yes | Status name |
| string | Yes | URL-friendly slug |
| string | Yes | Status color |
| string ( | Yes | Status category |
| integer | No | Display order within category |
| boolean | No | Show on public roadmap |
| boolean | No | Set as default for new posts |
Response 201: returns id, name, slug, color, category, position, showOnRoadmap, isDefault, createdAt.
Get a status
GET /api/v1/statuses/{statusId}
Get a single status by ID
Parameters
Name | In | Type | Required | Description |
|---|---|---|---|---|
| path | string | Yes | Status ID |
Response 200: returns id, name, slug, color, category, position, showOnRoadmap, isDefault, createdAt.
Update a status
PATCH /api/v1/statuses/{statusId}
Update an existing status. Note: slug, category, and position cannot be changed via this endpoint.
Parameters
Name | In | Type | Required | Description |
|---|---|---|---|---|
| path | string | Yes | Status ID |
Request body
Field | Type | Required | Description |
|---|---|---|---|
| string | No | |
| string | No | Hex color code |
| boolean | No | |
| boolean | No |
Response 200: returns id, name, slug, color, category, position, showOnRoadmap, isDefault, createdAt.
Delete a status
DELETE /api/v1/statuses/{statusId}
Delete a status by ID. Cannot delete the default status or a status with assigned posts.
Parameters
Name | In | Type | Required | Description |
|---|---|---|---|---|
| path | string | Yes | Status ID |
Was this helpful?
Your feedback shapes what we write next.
