Read a page of a thread’s comments

GET

https://studio.runautomat.com/api/v1/projects/:projectId/collaboration/threads/:threadId/comments

GET

/api/v1/projects/:projectId/collaboration/threads/:threadId/comments

curl https://studio.runautomat.com/api/v1/projects/projectId/collaboration/threads/threadId/comments \
     -H "Authorization: Bearer <token>"

200Retrieved

{
  "comments": [
    {
      "id": "string",
      "thread_id": "string",
      "visibility": "shared",
      "author_side": "customer",
      "author_type": "user",
      "author_user_id": "string",
      "created_at": "string",
      "updated_at": "string",
      "withdrawn": false,
      "body": "string",
      "body_format": "plain",
      "parent_comment_id": "string",
      "shared_at": "string",
      "last_read_by_other_side_at": "string",
      "anchor_node_name": "string",
      "anchor_node_id": "string",
      "anchor_session_node_id": "string",
      "attachments": [
        {
          "id": "string",
          "filename": "string",
          "sizeBytes": 1.1,
          "mimeType": "string",
          "removed": true
        }
      ]
    }
  ],
  "people": {},
  "viewer": {
    "userId": "string",
    "side": "customer"
  },
  "pagination": {
    "page": 1.1,
    "pageSize": 1.1,
    "totalItems": 1.1,
    "totalPages": 1.1
  }
}

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

projectIdstringRequired

threadIdstringRequired

Query parameters

pageintegerOptional>=1Defaults to 1

pageSizeintegerOptional1-100Defaults to 50

Response

Declared primary response

commentslist of objects

peoplemap from strings to objects

viewerobject

paginationobject