Skip to main content
POST
get comments

Authorizations

Authorization
string
header
required

An API key (es_live_…) from Settings, under API keys, or an OAuth access token.

Headers

Idempotency-Key
string

Retry a paid dispatch safely: the same key returns the job already dispatched instead of charging again.

x-workspace-id
string

The workspace this one call acts in, when it is not the key's own.

Body

application/json
ref
string

The threads on one item.

canvas_id
string

The threads on one canvas.

timeline_id
string

The threads on one timeline.

The threads on one share page, visitors' comments included.

thread_id
string

One conversation, whole.

waiting_for_me
boolean

Only the threads someone in the workspace left waiting on your answer.

include_archived
boolean

Also the threads somebody has put away.

Words to find, over every message in a thread.

limit
integer
Required range: 1 <= x <= 200
cursor
string

next_cursor from the page before, with the same filters.

Response

Done, or a job started for work that runs longer (follow it with get_jobs).

ok
any
required
data
object
required
meta
object
required
media
object[]