Skip to content
HeyX API

List Customer Comments

Required scope: customer_comment:read

Use this endpoint to read a customer’s internal comment thread. Top-level comments are returned each with their replies nested. Each comment includes the author’s display name, timestamps, an isEdited flag, and a replyCount.

Only comments the API key’s member is allowed to read are returned. Comment attachments and mention wiring are not included; retrieve a customer’s files through the document and photo endpoints. Read the prior bodies of an edited comment with List Customer Comment History.

Generated Reference
POST /public-api/publicapi.v1.Customer/ListCustomerComments

Lists a customer's internal comment thread: top-level comments each with their replies nested. Read-only; only comments the API key's member can read are returned.

Request ListCustomerCommentsRequest
Response ListCustomerCommentsResponse

ListCustomerCommentsRequest

Field Type Description
customer_id string Customer whose comment thread is returned.

ListCustomerCommentsResponse

Field Type Description
comments repeated CustomerComment Top-level comments, each with its replies nested. Excludes comments the API key's member may not read.

Related Types

CustomerComment

Field Type Description
id string Unique identifier of the comment.
customer_id string Customer the comment belongs to.
body string Plain-text body of the comment.
attachments repeated CustomerAttachment Attachments linked when the comment was created. Populated by CreateCustomerComment; ListCustomerComments does not return attachment payloads. Fetch a customer's files through the document and photo endpoints.
created_at int64 Unix timestamp in seconds when the comment was created.
updated_at int64 Unix timestamp in seconds when the comment was last updated.
author_name string Display name of the member who wrote the comment. Empty when the author is unavailable, for example an API-key or system comment.
is_edited bool True when the comment has a saved edit history. Read the prior bodies with ListCustomerCommentHistory.
parent_id string Set when this comment is a reply; the ID of the top-level comment it answers. Empty for top-level comments.
reply_count int32 Number of replies to this comment.
replies repeated CustomerComment Replies to this comment, oldest first. Only populated for top-level comments returned by ListCustomerComments.

CustomerAttachment

Field Type
id string
kind CustomerAttachmentKind
visibility CustomerFileVisibility
filename string
original_filename string
content_type string
size_bytes int64
description string
created_at int64
updated_at int64

Request

Section titled “Request”
{
  "customerId": "be85f4d1-b680-4964-bf62-9828fdf4ce04"
}

Example

Section titled “Example”
Terminal window
curl https://portal.heyx.app/public-api/publicapi.v1.Customer/ListCustomerComments \
  -H "Authorization: Bearer hx_sk_..." \
  -H "Content-Type: application/json" \
  -d '{"customerId": "be85f4d1-b680-4964-bf62-9828fdf4ce04"}'

Response

Section titled “Response”
{
  "comments": [
    {
      "id": "a2ec8aef-691a-4e9d-b4fd-52e255883c6c",
      "customerId": "be85f4d1-b680-4964-bf62-9828fdf4ce04",
      "body": "Imported note from ERP",
      "authorName": "Alex Example",
      "isEdited": false,
      "replyCount": 1,
      "replies": [
        {
          "id": "e4b1c0d2-3f5a-4c6b-8d7e-9f0a1b2c3d4e",
          "customerId": "be85f4d1-b680-4964-bf62-9828fdf4ce04",
          "body": "Thanks, following up.",
          "authorName": "Sam Example",
          "isEdited": true,
          "parentId": "a2ec8aef-691a-4e9d-b4fd-52e255883c6c"
        }
      ]
    }
  ]
}
HeyX API