Skip to main content
GET
/
comments
/
{entityId}
/
list
List comments for an entity and branch
curl --request GET \
  --url https://api.example.com/comments/{entityId}/list
{
  "data": [
    {
      "type": "<string>",
      "id": "<string>",
      "entityId": "<string>",
      "branchId": "<string>",
      "comment": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "pageInfo": {
    "first": true,
    "last": true
  },
  "totalCount": 123,
  "currentPage": 123,
  "totalPages": 123
}

Path Parameters

entityId
string
required

Id of the entity (policy, customer, branch, ...)

Query Parameters

branchId
string

Optional: the branchId

count
number
default:10

the number of items to return

page
number
default:1

the page to retrieve

Response

200 - application/json
data
object[]
required

the list of items in the page

pageInfo
object
required

the page info

totalCount
number
required

the total number of items

currentPage
number
required

the current page

totalPages
number
required

the total number of pages