Skip to main content
GET
List comments

Authorizations

Authorization
string
header
required

Personal access token, sent as Authorization: Bearer <token>. Each operation lists the permission it needs: read_only or full_access. A full-access token can call every operation. A read-only token can call only the operations that list read_only; anything else returns 403 read_only_credential_route_not_allowed.

Path Parameters

app_id
string
required

ID of the app.

Query Parameters

include_resolved
boolean

Set to true to include resolved threads. Defaults to false.

limit
integer

Threads per page, 1 to 500. Defaults to 500.

Required range: 1 <= x <= 500
cursor
string

next_cursor from the previous page. Send it on its own: it carries include_resolved and limit, so sending either beside it returns a 400.

branch_id
string

ID of the branch to work on, as returned by List branches. Omit it to work on the app's main branch.

Response

One page of the app's comment threads, newest first.

One page of an app's comment threads.

items
CommentThreadItem · object[]
required

Threads on this page, newest first.

Example:
has_more
boolean
required

Whether more threads follow this page.

Example:

false

next_cursor
string | null
required

Pass as cursor to get the next page. null on the last page.

Example:

"gAAAAABn7vJ0q2kX"