Get Comments
curl --request POST \
--url https://api.velt.dev/v2/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
]
}
}
'import requests
url = "https://api.velt.dev/v2/commentannotations/comments/get"
payload = { "data": {
"organizationId": "<string>",
"documentId": "<string>",
"annotationId": "<string>",
"userIds": ["<string>"],
"commentIds": [123]
} }
headers = {
"x-velt-api-key": "<x-velt-api-key>",
"x-velt-auth-token": "<x-velt-auth-token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-velt-api-key': '<x-velt-api-key>',
'x-velt-auth-token': '<x-velt-auth-token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
data: {
organizationId: '<string>',
documentId: '<string>',
annotationId: '<string>',
userIds: ['<string>'],
commentIds: [123]
}
})
};
fetch('https://api.velt.dev/v2/commentannotations/comments/get', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.velt.dev/v2/commentannotations/comments/get",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'data' => [
'organizationId' => '<string>',
'documentId' => '<string>',
'annotationId' => '<string>',
'userIds' => [
'<string>'
],
'commentIds' => [
123
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-velt-api-key: <x-velt-api-key>",
"x-velt-auth-token: <x-velt-auth-token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.velt.dev/v2/commentannotations/comments/get"
payload := strings.NewReader("{\n \"data\": {\n \"organizationId\": \"<string>\",\n \"documentId\": \"<string>\",\n \"annotationId\": \"<string>\",\n \"userIds\": [\n \"<string>\"\n ],\n \"commentIds\": [\n 123\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-velt-api-key", "<x-velt-api-key>")
req.Header.Add("x-velt-auth-token", "<x-velt-auth-token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.velt.dev/v2/commentannotations/comments/get")
.header("x-velt-api-key", "<x-velt-api-key>")
.header("x-velt-auth-token", "<x-velt-auth-token>")
.header("Content-Type", "application/json")
.body("{\n \"data\": {\n \"organizationId\": \"<string>\",\n \"documentId\": \"<string>\",\n \"annotationId\": \"<string>\",\n \"userIds\": [\n \"<string>\"\n ],\n \"commentIds\": [\n 123\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.velt.dev/v2/commentannotations/comments/get")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-velt-api-key"] = '<x-velt-api-key>'
request["x-velt-auth-token"] = '<x-velt-auth-token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": {\n \"organizationId\": \"<string>\",\n \"documentId\": \"<string>\",\n \"annotationId\": \"<string>\",\n \"userIds\": [\n \"<string>\"\n ],\n \"commentIds\": [\n 123\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"result": {
"status": "success",
"message": "Comments retrieved successfully.",
"data": [
{
"commentId": 123456,
"type": "text",
"status": "updated",
"isDraft": false,
"isCommentTextAvailable": true,
"commentText": "This is a sample comment text.",
"commentHtml": "<p>This is a sample comment text.</p>",
"createdAt": 1777973714914,
"lastUpdated": "2026-05-05T09:35:15.048Z",
"to": [],
"toOrganizationUserGroup": [],
"taggedUserContacts": [],
"attachments": [],
"recorders": [],
"customList": [],
"reactionAnnotationIds": [
"reactionAnnotationId1",
"reactionAnnotationId2"
],
"reactionAnnotations": [
{
"annotationId": "reactionAnnotationId1",
"type": "reaction",
"icon": "RAISED_HANDS",
"commentAnnotationId": "yourAnnotationId",
"locationId": 5509827173770816,
"location": {
"version": {
"id": "v1",
"name": "Version 1"
}
},
"context": {
"access": {
"default": "velt"
},
"accessFields": [
"default:velt"
]
},
"lastUpdated": 1777978712656,
"fromUsers": [
{
"lastUpdated": 1777978709472,
"from": {
"userId": "user123",
"organizationId": "yourOrganizationId",
"photoUrl": "",
"initial": "J",
"clientUserName": "John Doe",
"name": "John Doe",
"name_lowercase": "johndoe",
"groupId": "yourGroupId",
"type": "signedIn",
"contacts": [],
"email": "john.doe@example.com",
"email_lowercase": "john.doe@example.com",
"color": "#a259fe",
"textColor": "#FFFFFF",
"isAdmin": false
}
}
]
}
],
"from": {
"userId": "user123",
"organizationId": "yourOrganizationId",
"photoUrl": "",
"initial": "J",
"clientUserName": "John Doe",
"name": "John Doe",
"name_lowercase": "johndoe",
"groupId": "yourGroupId",
"type": "signedIn",
"contacts": [],
"email": "john.doe@example.com",
"email_lowercase": "john.doe@example.com",
"color": "#a259fe",
"textColor": "#FFFFFF",
"isAdmin": false
}
}
]
}
}
Comments
Get Comments
POST
/
v2
/
commentannotations
/
comments
/
get
Get Comments
curl --request POST \
--url https://api.velt.dev/v2/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
]
}
}
'import requests
url = "https://api.velt.dev/v2/commentannotations/comments/get"
payload = { "data": {
"organizationId": "<string>",
"documentId": "<string>",
"annotationId": "<string>",
"userIds": ["<string>"],
"commentIds": [123]
} }
headers = {
"x-velt-api-key": "<x-velt-api-key>",
"x-velt-auth-token": "<x-velt-auth-token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-velt-api-key': '<x-velt-api-key>',
'x-velt-auth-token': '<x-velt-auth-token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
data: {
organizationId: '<string>',
documentId: '<string>',
annotationId: '<string>',
userIds: ['<string>'],
commentIds: [123]
}
})
};
fetch('https://api.velt.dev/v2/commentannotations/comments/get', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.velt.dev/v2/commentannotations/comments/get",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'data' => [
'organizationId' => '<string>',
'documentId' => '<string>',
'annotationId' => '<string>',
'userIds' => [
'<string>'
],
'commentIds' => [
123
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-velt-api-key: <x-velt-api-key>",
"x-velt-auth-token: <x-velt-auth-token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.velt.dev/v2/commentannotations/comments/get"
payload := strings.NewReader("{\n \"data\": {\n \"organizationId\": \"<string>\",\n \"documentId\": \"<string>\",\n \"annotationId\": \"<string>\",\n \"userIds\": [\n \"<string>\"\n ],\n \"commentIds\": [\n 123\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-velt-api-key", "<x-velt-api-key>")
req.Header.Add("x-velt-auth-token", "<x-velt-auth-token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.velt.dev/v2/commentannotations/comments/get")
.header("x-velt-api-key", "<x-velt-api-key>")
.header("x-velt-auth-token", "<x-velt-auth-token>")
.header("Content-Type", "application/json")
.body("{\n \"data\": {\n \"organizationId\": \"<string>\",\n \"documentId\": \"<string>\",\n \"annotationId\": \"<string>\",\n \"userIds\": [\n \"<string>\"\n ],\n \"commentIds\": [\n 123\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.velt.dev/v2/commentannotations/comments/get")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-velt-api-key"] = '<x-velt-api-key>'
request["x-velt-auth-token"] = '<x-velt-auth-token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": {\n \"organizationId\": \"<string>\",\n \"documentId\": \"<string>\",\n \"annotationId\": \"<string>\",\n \"userIds\": [\n \"<string>\"\n ],\n \"commentIds\": [\n 123\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"result": {
"status": "success",
"message": "Comments retrieved successfully.",
"data": [
{
"commentId": 123456,
"type": "text",
"status": "updated",
"isDraft": false,
"isCommentTextAvailable": true,
"commentText": "This is a sample comment text.",
"commentHtml": "<p>This is a sample comment text.</p>",
"createdAt": 1777973714914,
"lastUpdated": "2026-05-05T09:35:15.048Z",
"to": [],
"toOrganizationUserGroup": [],
"taggedUserContacts": [],
"attachments": [],
"recorders": [],
"customList": [],
"reactionAnnotationIds": [
"reactionAnnotationId1",
"reactionAnnotationId2"
],
"reactionAnnotations": [
{
"annotationId": "reactionAnnotationId1",
"type": "reaction",
"icon": "RAISED_HANDS",
"commentAnnotationId": "yourAnnotationId",
"locationId": 5509827173770816,
"location": {
"version": {
"id": "v1",
"name": "Version 1"
}
},
"context": {
"access": {
"default": "velt"
},
"accessFields": [
"default:velt"
]
},
"lastUpdated": 1777978712656,
"fromUsers": [
{
"lastUpdated": 1777978709472,
"from": {
"userId": "user123",
"organizationId": "yourOrganizationId",
"photoUrl": "",
"initial": "J",
"clientUserName": "John Doe",
"name": "John Doe",
"name_lowercase": "johndoe",
"groupId": "yourGroupId",
"type": "signedIn",
"contacts": [],
"email": "john.doe@example.com",
"email_lowercase": "john.doe@example.com",
"color": "#a259fe",
"textColor": "#FFFFFF",
"isAdmin": false
}
}
]
}
],
"from": {
"userId": "user123",
"organizationId": "yourOrganizationId",
"photoUrl": "",
"initial": "J",
"clientUserName": "John Doe",
"name": "John Doe",
"name_lowercase": "johndoe",
"groupId": "yourGroupId",
"type": "signedIn",
"contacts": [],
"email": "john.doe@example.com",
"email_lowercase": "john.doe@example.com",
"color": "#a259fe",
"textColor": "#FFFFFF",
"isAdmin": false
}
}
]
}
}
Use this API to retrieve comments in a specific CommentAnnotation.
Additional filters can be applied using comment IDs.
Prior to using this API, you must:
- Enable advanced queries option in the console
- Deploy v4 series of the Velt SDK.
Endpoint
POST https://api.velt.dev/v2/commentannotations/comments/get
Headers
string
required
Your API key.
string
required
Your Auth Token.
Body
Params
object
required
Example Requests
1. Get all comments with a CommentAnnotation by organizationId, documentId, and annotationId
{
"data": {
"organizationId": "yourOrganizationId",
"documentId": "yourDocumentId",
"annotationId": "yourAnnotationId"
}
}
2. Get specific comments of a CommentAnnotation by organizationId, documentId, annotationId and commentIds
{
"data": {
"organizationId": "yourOrganizationId",
"documentId": "yourDocumentId",
"annotationId": "yourAnnotationId",
"commentIds": [
153783,
607395
]
}
}
Response
Success Response
{
"result": {
"status": "success",
"message": "Comments retrieved successfully.",
"data": [
{
"commentId": 123456,
"type": "text",
"status": "updated",
"isDraft": false,
"isCommentTextAvailable": true,
"commentText": "This is a sample comment text.",
"commentHtml": "<p>This is a sample comment text.</p>",
"createdAt": 1777973714914,
"lastUpdated": "2026-05-05T09:35:15.048Z",
"to": [],
"toOrganizationUserGroup": [],
"taggedUserContacts": [],
"attachments": [],
"recorders": [],
"customList": [],
"reactionAnnotationIds": [
"reactionAnnotationId1",
"reactionAnnotationId2"
],
"reactionAnnotations": [
{
"annotationId": "reactionAnnotationId1",
"type": "reaction",
"icon": "RAISED_HANDS",
"commentAnnotationId": "yourAnnotationId",
"locationId": 5509827173770816,
"location": {
"version": {
"id": "v1",
"name": "Version 1"
}
},
"context": {
"access": {
"default": "velt"
},
"accessFields": [
"default:velt"
]
},
"lastUpdated": 1777978712656,
"fromUsers": [
{
"lastUpdated": 1777978709472,
"from": {
"userId": "user123",
"organizationId": "yourOrganizationId",
"photoUrl": "",
"initial": "J",
"clientUserName": "John Doe",
"name": "John Doe",
"name_lowercase": "johndoe",
"groupId": "yourGroupId",
"type": "signedIn",
"contacts": [],
"email": "john.doe@example.com",
"email_lowercase": "john.doe@example.com",
"color": "#a259fe",
"textColor": "#FFFFFF",
"isAdmin": false
}
},
{
"lastUpdated": 1777978712656,
"from": {
"userId": "guestUser456",
"organizationId": "yourOrganizationId",
"isGuest": true,
"initial": "P",
"clientUserName": "Powerful Panda",
"name": "Powerful Panda",
"name_lowercase": "powerfulpanda",
"type": "signedIn",
"contacts": [],
"email": "guest@example.com",
"email_lowercase": "guest@example.com",
"photoUrl": "https://example.com/avatars/powerful_panda.svg",
"color": "#67DBF4",
"textColor": "#FFFFFF",
"isAdmin": false
}
}
]
},
{
"annotationId": "reactionAnnotationId2",
"type": "reaction",
"icon": "HEART_FACE",
"commentAnnotationId": "yourAnnotationId",
"locationId": 5509827173770816,
"location": {
"version": {
"id": "v1",
"name": "Version 1"
}
},
"context": {
"access": {
"default": "velt"
},
"accessFields": [
"default:velt"
]
},
"lastUpdated": 1777978714205,
"fromUsers": [
{
"lastUpdated": 1777978714205,
"from": {
"userId": "guestUser456",
"organizationId": "yourOrganizationId",
"isGuest": true,
"initial": "P",
"clientUserName": "Powerful Panda",
"name": "Powerful Panda",
"name_lowercase": "powerfulpanda",
"type": "signedIn",
"contacts": [],
"email": "guest@example.com",
"email_lowercase": "guest@example.com",
"photoUrl": "https://example.com/avatars/powerful_panda.svg",
"color": "#67DBF4",
"textColor": "#FFFFFF",
"isAdmin": false
}
}
]
}
],
"from": {
"userId": "user123",
"organizationId": "yourOrganizationId",
"photoUrl": "",
"initial": "J",
"clientUserName": "John Doe",
"name": "John Doe",
"name_lowercase": "johndoe",
"groupId": "yourGroupId",
"type": "signedIn",
"contacts": [],
"email": "john.doe@example.com",
"email_lowercase": "john.doe@example.com",
"color": "#a259fe",
"textColor": "#FFFFFF",
"isAdmin": false
}
},
null // If a requested commentId was not found
]
}
}
{
"result": {
"status": "success",
"message": "Comments retrieved successfully.",
"data": [
{
"commentId": 123456,
"type": "text",
"status": "updated",
"isDraft": false,
"isCommentTextAvailable": true,
"commentText": "This is a sample comment text.",
"commentHtml": "<p>This is a sample comment text.</p>",
"createdAt": 1777973714914,
"lastUpdated": "2026-05-05T09:35:15.048Z",
"to": [],
"toOrganizationUserGroup": [],
"taggedUserContacts": [],
"attachments": [],
"recorders": [],
"customList": [],
"reactionAnnotationIds": [
"reactionAnnotationId1",
"reactionAnnotationId2"
],
"reactionAnnotations": [
{
"annotationId": "reactionAnnotationId1",
"type": "reaction",
"icon": "RAISED_HANDS",
"commentAnnotationId": "yourAnnotationId",
"locationId": 5509827173770816,
"location": {
"version": {
"id": "v1",
"name": "Version 1"
}
},
"context": {
"access": {
"default": "velt"
},
"accessFields": [
"default:velt"
]
},
"lastUpdated": 1777978712656,
"fromUsers": [
{
"lastUpdated": 1777978709472,
"from": {
"userId": "user123",
"organizationId": "yourOrganizationId",
"photoUrl": "",
"initial": "J",
"clientUserName": "John Doe",
"name": "John Doe",
"name_lowercase": "johndoe",
"groupId": "yourGroupId",
"type": "signedIn",
"contacts": [],
"email": "john.doe@example.com",
"email_lowercase": "john.doe@example.com",
"color": "#a259fe",
"textColor": "#FFFFFF",
"isAdmin": false
}
}
]
}
],
"from": {
"userId": "user123",
"organizationId": "yourOrganizationId",
"photoUrl": "",
"initial": "J",
"clientUserName": "John Doe",
"name": "John Doe",
"name_lowercase": "johndoe",
"groupId": "yourGroupId",
"type": "signedIn",
"contacts": [],
"email": "john.doe@example.com",
"email_lowercase": "john.doe@example.com",
"color": "#a259fe",
"textColor": "#FFFFFF",
"isAdmin": false
}
}
]
}
}
Was this page helpful?
⌘I