Misc · Todo · Projects
Get todo project
Gets one todo project in an organization, identified by organizationId and projectId. Returns the project, including its name, color, description, and todo counters.
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 either
todoProject.readortodoItem.read. - Actor details may be masked without
user.read. For non-contact actors, the current actor is exempt from this check. - API actor details may be masked without
apiKey.read.
Request
Path parameters
-
organizationIdidrequired -
projectIdidrequired
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/YOUR_PROJECT_ID' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/misc/todo/projects/YOUR_PROJECT_ID", {
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/YOUR_PROJECT_ID', 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
-
_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
Response200
{
"_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"
}
}
}
Errors
Other errors
| Status | Error | When |
|---|---|---|
| 403 | No fixed message | Returns HTTP 403 if the caller has neither todoProject.read nor todoItem.read. |
| 404 | The todo project was not found | Returns HTTP 404 with key routes.misc.todo.projects.notFound if the project is not found in the organization. |
Errors nearly every request can meet are listed under Errors.