cURL
curl --request POST \ --url https://api.velt.dev/v1/commentannotations/comments/get \ --header 'Content-Type: application/json' \ --header 'x-velt-api-key: <x-velt-api-key>' \ --header 'x-velt-auth-token: <x-velt-auth-token>' \ --data '{ "data": { "organizationId": "<string>", "documentId": "<string>", "annotationId": "<string>", "userIds": [ "<string>" ], "commentIds": [ 123 ] } }'
{ "result": { "status": "success", "message": "Comments(s) retrieved successfully.", "data": [ { "commentHtml": "<div>Hello Updated 2</div>", "commentId": 153783, "commentText": "Sample Comment Text", "from": { "email": "user@example.com", "name": "User Name", "userId": "yourUserId" }, "lastUpdated": "2024-06-20T09:53:42.258Z", "status": "added", "type": "text" } ] } }
POST https://api.velt.dev/v1/commentannotations/comments/get
Show properties
{ "data": { "organizationId": "yourOrganizationId", "documentId": "yourDocumentId", "annotationId": "yourAnnotationId" } }
{ "data": { "organizationId": "yourOrganizationId", "documentId": "yourDocumentId", "annotationId": "yourAnnotationId", "commentIds": [ 153783, 607395 ] } }
{ "result": { "status": "success", "message": "Comments(s) retrieved successfully.", "data": [ { "commentHtml": "<div>Hello Updated 2</div>", "commentId": 153783, "commentText": "Sample Comment Text", "from": { "email": "user@example.com", "name": "User Name", "userId": "yourUserId" }, "lastUpdated": "2024-06-20T09:53:42.258Z", "status": "added", "type": "text" }, null // If comment not found ] } }
Was this page helpful?