GET
/
v1
/
comments
curl --request GET \
  --url https://platform.thena.ai/v1/comments \
  --header 'Authorization: Bearer <token>' \
  --header 'x-org-id: <api-key>'
{
  "status": true,
  "message": "Success",
  "timestamp": "2024-01-01T00:00:00.000Z",
  "data": [
    {
      "id": "<string>",
      "content": "<string>",
      "contentHtml": "<string>",
      "contentMarkdown": "<string>",
      "isEdited": true,
      "threadName": "<string>",
      "commentVisibility": "<string>",
      "commentType": "<string>",
      "isPinned": true,
      "sourceEmailId": "<string>",
      "metadata": {},
      "parentCommentId": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "author": "<string>",
      "authorId": "<string>",
      "authorUserType": "<string>",
      "customerContactId": "<string>",
      "customerContactEmail": "<string>",
      "authorAvatarUrl": "<string>",
      "attachments": [
        "<string>"
      ]
    }
  ]
}

Authorizations

Authorization
string
header
required

Enter JWT bearer token

x-org-id
string
header
required

Enter organization ID

Query Parameters

page
number

The page number

limit
number

The limit number of comments to fetch

entityType
string
required

The type of the entity

entityId
string
required

The identifier of the entity

Response

200
application/json
Operation successful
status
boolean
default:true
required

The status of the response

message
string
default:Success
required

The message of the response

timestamp
string
default:2024-01-01T00:00:00.000Z
required

The timestamp of the response

data
object[]
required

The comments fetched