Misc · Todo · Projects
List todo projects
Lists todo projects with their names, colors and descriptions
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Permission checks in detail
Required permissions
- todoProject.read or todoItem.read
Also checked, depending on the request and the records it touches
user.readapiKey.readcontact:member.readcontact:address.readcontact:customer.readcontact:sponsor.readcontact:contributor.readcontact:employee.readcontact:supplier.readcontact.read
Request
Path parameters
-
organizationIdidrequired
Query parameters
-
sortobject of stringascdescKeys: one of 44 values
_idcreatedAtupdatedAtremovedAtcreatedBy.namecreatedBy.typecreatedBy.userIdcreatedBy.image.resourcecreatedBy.image.fileNamecreatedBy.image.contentTypecreatedBy.image.fileSizeBytescreatedBy.keyupdatedBy.nameupdatedBy.typeupdatedBy.userIdupdatedBy.image.resourceupdatedBy.image.fileNameupdatedBy.image.contentTypeupdatedBy.image.fileSizeBytesupdatedBy.keyremovedBy.nameremovedBy.typeremovedBy.userIdremovedBy.image.resourceremovedBy.image.fileNameremovedBy.image.contentTyperemovedBy.image.fileSizeBytesremovedBy.key__ignoreTriggersorganizationnamecolordescriptionopenCountclosedCountarchivedAtarchivedBy.namearchivedBy.typearchivedBy.userIdarchivedBy.image.resourcearchivedBy.image.fileNamearchivedBy.image.contentTypearchivedBy.image.fileSizeBytesarchivedBy.key -
limitinteger0–20 · default
20 -
offsetintegerat least 0 · default
0 -
returnCountbooleandefault
false -
includeArchivedbooleandefault
false -
archivedboolean -
userFilterstringnullable -
searchTermstring1–100 characters
-
projectIdsid[]at most 50 items
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request GET 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/misc/todo/projects' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/misc/todo/projects", {
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/projects', 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
-
projectsobject[]16 properties
-
_idid -
createdAtstring · date-timenullable -
updatedAtstring · date-timenullable -
removedAtstring · date-timenullable -
createdByobjectnullable -
updatedByobjectnullable -
removedByobjectnullable -
__ignoreTriggersstringnullable -
organizationid -
namestring1–64 characters
-
colorstring22 values
slategrayzincneutralstoneredorangeamberyellowlimegreenemeraldtealcyanskyblueindigovioletpurplefuchsiapinkrose -
descriptionstringat most 400 characters
-
openCountintegerat least 0
-
closedCountintegerat least 0
-
archivedAtstring · date-timenullable -
archivedByobjectnullable
-
-
countintegerat least 0
Response200
{
"projects": [
{
"_id": "000000000000000000000001",
"organization": "000000000000000000000001",
"name": "string",
"color": "slate",
"description": "string",
"openCount": 0,
"closedCount": 0,
"archivedAt": "2026-06-15T22:30:00Z",
"archivedBy": {
"name": "string",
"type": "user",
"userId": "string",
"image": {
"resource": "string"
}
}
}
],
"count": 0
}
Errors
No errors of its own are known for this endpoint.
Errors nearly every request can meet are listed under Errors.