Skip to navigation

List product comments

List the comment threads on a product’s canvas with their messages. Threads belong to the product’s organization; a personal account’s product has none.

Authentication

AuthorizationBearer
API key or Clerk session token

Path parameters

idstringRequired

Query parameters

statusenumOptional

Which threads to list; defaults to all

Allowed values:
limitintegerOptional1-500

The newest threads to return, at most 500 (the default)

cursorstringOptional

The nextCursor of the previous page: lists the threads older than that page

idsstringOptional

Comma-separated thread ids, at most limit of them: lists only those threads, in their current state

Response

Comment threads
hasMoreboolean

True when older threads were left out by limit

nextCursorstring or null

Pass as cursor to list the threads older than this page; null once none are left

threadslist of objects

Oldest first: the newest limit threads

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error