Misc · Todo · Items · Comments
List todo comments
Lists a todo item's comments in chronological order. Accepts an offset and limit, defaulting to 0 and 20; the limit can be from 1 to 20. Returns comments and a hasMore flag.
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Who may call it
- The caller must have organization access.
- The caller needs
todoItem.read, or must be an assignee or the reviewer of the todo. - When organization access is not null, non-contact actors other than the current actor are masked without
user.read. - When organization access is not null, API key actors are masked without
apiKey.read, even if they are the current actor. - The legacy permission
contact.readalso permits contact actor details to be shown.
Request
Path parameters
-
organizationIdidrequired -
itemIdidrequired
Query parameters
-
offsetintegerat least 0 · default
0 -
limitinteger1–20 · default
20
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request GET 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/misc/todo/items/YOUR_ITEM_ID/comments' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/misc/todo/items/YOUR_ITEM_ID/comments", {
method: "GET",
headers: {
"X-API-Key": "YOUR_API_KEY"
},
redirect: 'error',
signal: AbortSignal.timeout(30_000),
});
if (!response.ok) throw new Error(`campai HTTP ${response.status}`);
const text = await response.text();
const result = text ? JSON.parse(text) : null;
console.log(JSON.stringify(result, null, 2));<?php
$context = stream_context_create(['http' => [
'method' => 'GET',
'header' => [
'X-API-Key: YOUR_API_KEY',
],
'timeout' => 30,
'follow_location' => 0,
'ignore_errors' => true,
]]);
$text = @file_get_contents('https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/misc/todo/items/YOUR_ITEM_ID/comments', false, $context);
preg_match('/^HTTP\/\S+ (\d{3})/', $http_response_header[0] ?? '', $match);
$status = (int) ($match[1] ?? 0);
if ($text === false || $status < 200 || $status >= 300) {
throw new RuntimeException("campai HTTP $status (0 means no response)");
}
$result = $text === '' ? null : json_decode($text, true, 512, JSON_THROW_ON_ERROR);
echo json_encode($result, JSON_PRETTY_PRINT | JSON_THROW_ON_ERROR), PHP_EOL;
Response
200 Successful response
Content-Type: application/json
-
commentsobject[]12 properties
-
_idid -
createdAtstring · date-timenullable -
updatedAtstring · date-timenullable -
removedAtstring · date-timenullable -
createdByobjectnullable -
updatedByobjectnullable -
removedByobjectnullable -
__ignoreTriggersstringnullable -
organizationid -
todoItemid -
descriptionstring1–10000 characters
-
attachmentsobject[]at most 10 items
5 properties
-
resourcestringat least 1 characters
-
fileNamestringat most 128 characters
-
contentTypestringat most 75 characters
-
fileSizeBytesintegerat least 0
-
idstringexactly 6 characters
-
-
-
hasMoreboolean
Response200
{
"comments": [
{
"_id": "000000000000000000000001",
"organization": "000000000000000000000001",
"todoItem": "000000000000000000000001",
"description": "string",
"attachments": [
{
"resource": "string",
"id": "string"
}
]
}
],
"hasMore": true
}
Errors
Other errors
| Status | Error | When |
|---|---|---|
| 404 | Todo not found | If the todo is not found, or the caller lacks todoItem.read and is neither an assignee nor the reviewer, the endpoint returns HTTP 404 with key libCommon.misc.todo.errors.todoNotFound. |
Errors nearly every request can meet are listed under Errors.