Votes API reference

Votes endpoints of the Quackback REST API: paths, parameters, request fields and responses.

JM
James Morton
Written By James MortonLast updated 4 days ago

This is the reference for the Votes 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

  • POST /posts/{postId}/vote: Toggle vote on a post
  • POST /posts/{postId}/vote/proxy: Add a proxy vote
  • DELETE /posts/{postId}/vote/proxy: Remove a vote
  • GET /posts/{postId}/voters: List voters on a post

Toggle vote on a post

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

Vote or unvote on a post (toggle)

Parameters

Name

In

Type

Required

Description

postId

path

string

Yes

Post ID

Response 200: returns voted, voteCount.

Add a proxy vote

POST /api/v1/posts/{postId}/vote/proxy

Add a vote on behalf of another user (insert-only, never toggles). Requires team role.

Parameters

Name

In

Type

Required

Description

postId

path

string

Yes

Post ID

Request body

Field

Type

Required

Description

voterPrincipalId

string

Yes

Principal ID of the voter

Response 200: returns voted, voteCount.

Remove a vote

DELETE /api/v1/posts/{postId}/vote/proxy

Remove any vote (proxy, integration, or direct) for a user. Requires team role.

Parameters

Name

In

Type

Required

Description

postId

path

string

Yes

Post ID

Request body

Field

Type

Required

Description

voterPrincipalId

string

Yes

Principal ID of the voter

List voters on a post

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

Returns a paginated list of voters on a post, newest votes first

Parameters

Name

In

Type

Required

Description

postId

path

string

Yes

Post ID

cursor

query

string

No

Pagination cursor from previous response

limit

query

integer

No

Items per page (max 100)

Response 200: returns principalId, displayName, email, avatarUrl, isAnonymous, sourceType, sourceExternalUrl, addedByName, createdAt.

Was this helpful?

Your feedback shapes what we write next.