Skip to main content
GET
/
api
/
v1
/
comments
Error
A valid request URL is required to generate request examples
{
  "ok": "<unknown>",
  "meta": {
    "requestId": "<string>",
    "serverTime": "2023-11-07T05:31:56Z"
  },
  "data": {
    "items": [
      {
        "id": "<string>",
        "dbId": 123,
        "entity": {
          "type": "lead",
          "id": "<string>"
        },
        "fieldPath": "<string>",
        "authorUserId": "<string>",
        "content": "<string>",
        "parentCommentId": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "isDeleted": true,
        "replies": "<array>"
      }
    ],
    "page": {
      "pageSize": 250,
      "nextCursor": "<string>",
      "totalCount": 1
    }
  }
}

Query Parameters

entityType
enum<string>
required
Available options:
lead,
task,
contact,
gonogo,
signal,
draft,
filter
entityId
string
required
Minimum string length: 1
fieldPath
string
cursor
string | null

Opaque pagination cursor

pageSize
integer
default:50
Required range: 1 <= x <= 500

Response

OK

ok
any
required
meta
object
required
data
object
required