List comments

GET

/v1/data/{artifactId}/comments

const url = 'https://shareout.site/v1/data/example/comments?resolved=true&limit=100&skip=0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://shareout.site/v1/data/example/comments?resolved=true&limit=100&skip=0' \
  --header 'Authorization: Bearer <token>'

Comments on the artifact, newest first. Session cookie or Bearer token; the artifact’s comment identity mode decides who may read. 403 COMMENTS_DISABLED when comments are off for the artifact.

Authorizations

bearerAuth

Parameters

Path Parameters

artifactId

required

string

Artifact ID (e.g. art_abc123).

Query Parameters

contextId

string

parentId

string

A comment id for its replies, or null for top-level threads only.

resolved

string

Allowed values: true false

assignee

string

me or an email: only action items assigned to them.

limit

integer

default: 100 <= 1000

skip

integer

Responses

200

Comments

application/json

object

success

boolean

data

object

comments

Array<object>

object

cmt_ + 24 hex characters.

string

contextId

string | null

parentId

string | null

authorId

string | null

authorName

string

content

string

createdAt

string format: date-time

updatedAt

string format: date-time

resolved

boolean

resolvedBy

string | null

resolvedAt

string | null format: date-time

position

Pin position on the page, when the comment was placed as a pin.

mentions

Array<string>

authorType

guest = a verified guest with no account (their email is never returned).

string

Allowed values: human agent guest

assigneeUserId

string | null

assigneeEmail

string | null

dueAt

string | null format: date-time

versionId

Id of the version that was live when the comment was written; null on older comments.

string | null

reactions

object

key

additional properties

object

count

integer

mine

boolean

count

integer

Example

{
  "data": {
    "comments": [
      {
        "authorType": "human"
      }
    ]
  }
}

403

Access denied

application/json

object

success

required

boolean

error

required

Human-readable message.

string

code

required

Machine-readable error code.

string

request_id

Correlation id (also the X-Request-Id header). Quote it in support tickets.

string

reason

Finer cause under code. For UNAUTHORIZED: missing, invalid, revoked or expired.

string

hint

What to do next, in plain words.

string

suggestion

string

param

The request field at fault.

string

docs

Doc page for this error.

string

redirect_url

string

support

Present on 5xx — how to reach a human.

object

how

string

include

Array<string>

Example

{
  "success": false,
  "support": {
    "how": "POST /v1/support/tickets",
    "include": [
      "request_id"
    ]
  }
}