Comments API reference

This is the reference for the Comments 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 /posts/{postId}/comments: List comments on a post
• POST /posts/{postId}/comments: Add a comment to a post
• GET /comments/{commentId}: Get a comment
• PATCH /comments/{commentId}: Update a comment
• DELETE /comments/{commentId}: Delete a comment

List comments on a post

GET /api/v1/posts/{postId}/comments

Returns all comments on a post as a threaded tree with nested replies

Parameters

Response 200: returns id, postId, parentId, content, contentJson, authorName, principalId, isTeamMember, isPrivate, createdAt, reactions, replies.

Add a comment to a post

POST /api/v1/posts/{postId}/comments

Create a new comment on a post. The comment is attributed to the authenticated API key holder.

Parameters

Request body

Response 201: returns id, postId, parentId, content, contentJson, authorName, principalId, isTeamMember, isPrivate, createdAt.

Get a comment

GET /api/v1/comments/{commentId}

Get a single comment by ID

Parameters

Response 200: returns id, postId, parentId, content, contentJson, authorName, authorEmail, principalId, isTeamMember, isPrivate, createdAt, deletedAt.

Update a comment

PATCH /api/v1/comments/{commentId}

Update an existing comment

Parameters

Request body

Response 200: returns id, postId, parentId, content, contentJson, authorName, principalId, isTeamMember, isPrivate, createdAt.

Delete a comment

DELETE /api/v1/comments/{commentId}

Delete a comment by ID

Parameters