GET
/
v1
/
comments
/
user-type
cURL
curl --request GET \
  --url https://platform.thena.ai/v1/comments/user-type \
  --header 'x-api-key: <api-key>'
{
  "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

​
entityType
enum<string>
required

The type of the entity

Available options:
ticket,
account_activity,
account_note,
account_task
Example:

"ticket"

​
entityId
string
required

The identifier of the entity

Example:

"6MBZQQZJ103QZG547KY06M16MVVZV"

​
userType
enum<string>
required

The type of user

Available options:
agent,
customer,
all
Example:

"agent"

​
firstComment
boolean

Whether to get the first comment only

Example:

true

Response

Operation successful

The response is of type object.