GET
/
v1
/
comments
cURL
curl --request GET \
  --url https://platform.thena.ai/v1/comments \
  --header 'x-api-key: <api-key>'
{
  "status": true,
  "message": "Success",
  "timestamp": "2024-01-01T00:00:00.000Z",
  "data": [
    {
      "id": "<string>",
      "content": "<string>",
      "contentHtml": "<string>",
      "contentJson": "<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>",
      "customerContactFirstName": "<string>",
      "customerContactLastName": "<string>",
      "customerContactAvatarUrl": "<string>",
      "authorAvatarUrl": "<string>",
      "impersonatedUserEmail": "<string>",
      "impersonatedUserName": "<string>",
      "impersonatedUserAvatar": "<string>",
      "attachments": [
        "<string>"
      ],
      "deletedAt": "<string>"
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

Enter your API key

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

Operation successful

​
status
boolean
default:true
required

The status of the response

​
message
string
default:Success
required

The message of the response

​
timestamp
string<date-time>
default:2024-01-01T00:00:00.000Z
required

The timestamp of the response

​
data
object[]
required

The comments fetched