List client card comments

Request

Returns text comments and file upload history for one Location client. Requires clients_access and client_comments_list_access. File entries have type: file and a files array; text entries have type: default. Saving a form URL as comment text does not upload a completed document.

Security

BearerPartnerUser

Path

location_idnumberrequired

ID of a location.

Example:123

client_idnumberrequired

ID of a location client.

Example:123

Headers

Acceptstringrequired

Required B2B v2 response media type. Use application/vnd.api.v2+json. A charset parameter is also accepted.

Default:"application/vnd.api.v2+json"

Example:application/vnd.api.v2+json

Content-Typestringrequired

Should be equal to application/json

Example:application/json

curl -i -X GET \
  https://developer.alteg.io/_mock/en/b2b-v1/openapi/locations/123/clients/123/comments \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: application/json'

Responses

OK

Bodyapplication/json

successboolean(Successful response status)

Response status.

Example:true

dataArray of objects(Object of model "Comment for a client")

Example:

[
  {
    "id": 123,
    "create_date": "2026-01-01T12:12:12-05:00",
    "update_date": "2026-01-01T12:12:12-05:00",
    "type": "default",
    "text": "Comment for a client",
    "files": [],
    "user": { … },
    "is_editable": true
  }
]

metaobject(Meta object with response results count)

Additional response data.

Response

{
  "success": true,
  "data": [
    { … }
  ],
  "meta": {
    "count": 1
  }
}