V2 Comments

List record comments (v2)

get

Returns the comments attached to one record. Each comment includes typed content blocks so agents can render or summarize the discussion without extra transformation.

Path parameters

schemaIdstring · uuidRequired

recordIdstring · uuidRequired

Responses

200

Comments retrieved successfully

application/json

idstring · uuidOptional

recordIdstring · uuidOptional

createdAtstring · date-timeOptional

createdBystringOptional

401

Unauthorized

application/json

404

Schema or record not found

application/json

get

/api/v2/schemas/{schemaId}/records/{recordId}/comments

HTTPcURLJavaScriptPython

GET /api/v2/schemas/{schemaId}/records/{recordId}/comments HTTP/1.1
Host: api-z2.zinkee.com
Accept: */*

[
  {
    "id": "c1d2e3f4-a5b6-7890-cdef-123456789012",
    "recordId": "550e8400-e29b-41d4-a716-446655440000",
    "createdAt": "2026-03-16T10:30:00Z",
    "createdBy": "[email protected]",
    "content": [
      {
        "type": "TEXT",
        "value": "Customer asked to review the contract before approval."
      }
    ]
  }
]

Create record comment (v2)

post

Creates one comment for a record. Send at least one content item. Use type TEXT for plain text comments unless the backend adds new content types.

Path parameters

schemaIdstring · uuidRequired

recordIdstring · uuidRequired

Body

application/json

Responses

200

Comment created successfully

application/json

idstring · uuidOptional

recordIdstring · uuidOptional

createdAtstring · date-timeOptional

createdBystringOptional

400

Invalid or empty comment payload

application/json

401

Unauthorized

application/json

404

Schema or record not found

application/json

post

/api/v2/schemas/{schemaId}/records/{recordId}/comments

HTTPcURLJavaScriptPython

POST /api/v2/schemas/{schemaId}/records/{recordId}/comments HTTP/1.1
Host: api-z2.zinkee.com
Content-Type: application/json
Accept: */*
Content-Length: 94

{
  "content": [
    {
      "type": "TEXT",
      "value": "Please confirm legal review before sending this quote."
    }
  ]
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "recordId": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2026-03-17T20:04:08.207Z",
  "createdBy": "text",
  "content": [
    {
      "type": "text",
      "value": "text"
    }
  ]
}