Misc · Todo · Topics
List todo topics
Lists todo topics and their available workflows
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Permission checks in detail
Required permissions
- todoTopic.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 107 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__ignoreTriggersorganizationnameidentifierlastSequenceNumbercolordescriptionrevisionopenCountclosedCountarchivedAtarchivedBy.namearchivedBy.typearchivedBy.userIdarchivedBy.image.resourcearchivedBy.image.fileNamearchivedBy.image.contentTypearchivedBy.image.fileSizeBytesarchivedBy.keycustomFields.groupscustomFields.pagescustomFields.submitCaptioncustomFields.appearance.accentColorcustomFields.appearance.accentTextColorcustomFields.appearance.box.border.widthcustomFields.appearance.box.border.colorcustomFields.appearance.box.border.radiuscustomFields.appearance.box.background.colorcustomFields.appearance.box.font.colorcustomFields.appearance.box.font.sizecustomFields.appearance.box.font.weightcustomFields.appearance.box.shadowscustomFields.appearance.box.padding.leftcustomFields.appearance.box.padding.rightcustomFields.appearance.box.padding.topcustomFields.appearance.box.padding.bottomcustomFields.appearance.box.margin.leftcustomFields.appearance.box.margin.rightcustomFields.appearance.box.margin.topcustomFields.appearance.box.margin.bottomcustomFields.appearance.groupBox.border.widthcustomFields.appearance.groupBox.border.colorcustomFields.appearance.groupBox.border.radiuscustomFields.appearance.groupBox.background.colorcustomFields.appearance.groupBox.font.colorcustomFields.appearance.groupBox.font.sizecustomFields.appearance.groupBox.font.weightcustomFields.appearance.groupBox.shadowscustomFields.appearance.groupBox.padding.leftcustomFields.appearance.groupBox.padding.rightcustomFields.appearance.groupBox.padding.topcustomFields.appearance.groupBox.padding.bottomcustomFields.appearance.groupBox.margin.leftcustomFields.appearance.groupBox.margin.rightcustomFields.appearance.groupBox.margin.topcustomFields.appearance.groupBox.margin.bottomcustomFields.appearance.inputBox.border.widthcustomFields.appearance.inputBox.border.colorcustomFields.appearance.inputBox.border.radiuscustomFields.appearance.inputBox.background.colorcustomFields.appearance.inputBox.font.colorcustomFields.appearance.inputBox.font.sizecustomFields.appearance.inputBox.font.weightcustomFields.appearance.inputBox.shadowscustomFields.appearance.inputBox.padding.leftcustomFields.appearance.inputBox.padding.rightcustomFields.appearance.inputBox.padding.topcustomFields.appearance.inputBox.padding.bottomcustomFields.appearance.inputBox.margin.leftcustomFields.appearance.inputBox.margin.rightcustomFields.appearance.inputBox.margin.topcustomFields.appearance.inputBox.margin.bottomcustomFields.appearance.inputBox.labelFont.colorcustomFields.appearance.inputBox.labelFont.sizecustomFields.appearance.inputBox.labelFont.weightcustomFields.appearance.inputBox.heightcustomFields.validationsstatusestypes -
limitinteger0–20 · default
20 -
offsetintegerat least 0 · default
0 -
returnCountbooleandefault
false -
includeArchivedbooleandefault
false -
archivedboolean -
userFilterstringnullable -
searchTermstring1–100 characters
-
topicIdsid[]at most 50 items
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request GET 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/misc/todo/topics' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/misc/todo/topics", {
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/topics', 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
-
topicsobject[]22 properties
-
_idid -
createdAtstring · date-timenullable -
updatedAtstring · date-timenullable -
removedAtstring · date-timenullable -
createdByobjectnullable -
updatedByobjectnullable -
removedByobjectnullable -
__ignoreTriggersstringnullable -
organizationid -
namestring1–80 characters
-
identifierstring1–4 characters
-
lastSequenceNumberintegerat least 0
-
colorstring22 values
slategrayzincneutralstoneredorangeamberyellowlimegreenemeraldtealcyanskyblueindigovioletpurplefuchsiapinkrose -
descriptionstringat most 10000 characters
-
revisionintegerat least 0
-
openCountintegerat least 0
-
closedCountintegerat least 0
-
archivedAtstring · date-timenullable -
archivedByobjectnullable -
customFieldsobjectnullable5 properties
-
groupsobject[]12 properties
-
idstring1–24 characters
-
pageIdstring1–24 characters
-
labelstringat most 140 characters
-
hintstringat most 280 characters
-
fieldsobject[] -
disabledboolean | object2 properties
-
operatorstringandor -
conditions(object (recursive) | object)[]at least 1 items
4 properties
-
leftobject | object of anyVariant 1: 1 property
-
variablestringat least 1 characters
Variant 2: 4 properties
-
sourceobject1 property
-
variablestringat least 1 characters
-
-
lookupobjectnullable1 property
-
variablestringat least 1 characters
-
-
arrayboolean -
selectobject (recursive)
Variant 3: 2 properties
-
funcstring33 values
concatifEmptylowercaseuppercasesubstringtrimabsceilfloorminmaxmodsumsubmuldivavgmedparseNumberformatNumberdateOnlydateTimedateOnlyPartdateTimePartagedateOnlyDifferencedateTimeDifferencesetDateOnlysetDateTimeaddDateOnlyaddDateTimeformatDateOnlyformatDateTime -
paramsobject (recursive)[]
Variant 4: 1 property
-
literalnumber[] | number
Variant 5: 3 properties
-
ifobject (recursive) -
thenobject (recursive) -
elseobject (recursive)
-
-
cmpFuncstring15 values
eqisSetltltegtgteincludescontainsstartsWithendsWithbeforebeforeAtafterafterAtisToday -
rightobject | object of anyVariant 1: 1 property
-
variablestringat least 1 characters
Variant 2: 4 properties
-
sourceobject1 property
-
variablestringat least 1 characters
-
-
lookupobjectnullable1 property
-
variablestringat least 1 characters
-
-
arrayboolean -
selectobject (recursive)
Variant 3: 2 properties
-
funcstring33 values
concatifEmptylowercaseuppercasesubstringtrimabsceilfloorminmaxmodsumsubmuldivavgmedparseNumberformatNumberdateOnlydateTimedateOnlyPartdateTimePartagedateOnlyDifferencedateTimeDifferencesetDateOnlysetDateTimeaddDateOnlyaddDateTimeformatDateOnlyformatDateTime -
paramsobject (recursive)[]
Variant 4: 1 property
-
literalnumber[] | number
Variant 5: 3 properties
-
ifobject (recursive) -
thenobject (recursive) -
elseobject (recursive)
-
-
negateboolean
-
-
-
hiddenboolean | object2 properties
-
operatorstringandor -
conditions(object (recursive) | object)[]at least 1 items
4 properties
-
leftobject | object of anyVariant 1: 1 property
-
variablestringat least 1 characters
Variant 2: 4 properties
-
sourceobject1 property
-
variablestringat least 1 characters
-
-
lookupobjectnullable1 property
-
variablestringat least 1 characters
-
-
arrayboolean -
selectobject (recursive)
Variant 3: 2 properties
-
funcstring33 values
concatifEmptylowercaseuppercasesubstringtrimabsceilfloorminmaxmodsumsubmuldivavgmedparseNumberformatNumberdateOnlydateTimedateOnlyPartdateTimePartagedateOnlyDifferencedateTimeDifferencesetDateOnlysetDateTimeaddDateOnlyaddDateTimeformatDateOnlyformatDateTime -
paramsobject (recursive)[]
Variant 4: 1 property
-
literalnumber[] | number
Variant 5: 3 properties
-
ifobject (recursive) -
thenobject (recursive) -
elseobject (recursive)
-
-
cmpFuncstring15 values
eqisSetltltegtgteincludescontainsstartsWithendsWithbeforebeforeAtafterafterAtisToday -
rightobject | object of anyVariant 1: 1 property
-
variablestringat least 1 characters
Variant 2: 4 properties
-
sourceobject1 property
-
variablestringat least 1 characters
-
-
lookupobjectnullable1 property
-
variablestringat least 1 characters
-
-
arrayboolean -
selectobject (recursive)
Variant 3: 2 properties
-
funcstring33 values
concatifEmptylowercaseuppercasesubstringtrimabsceilfloorminmaxmodsumsubmuldivavgmedparseNumberformatNumberdateOnlydateTimedateOnlyPartdateTimePartagedateOnlyDifferencedateTimeDifferencesetDateOnlysetDateTimeaddDateOnlyaddDateTimeformatDateOnlyformatDateTime -
paramsobject (recursive)[]
Variant 4: 1 property
-
literalnumber[] | number
Variant 5: 3 properties
-
ifobject (recursive) -
thenobject (recursive) -
elseobject (recursive)
-
-
negateboolean
-
-
-
minItemsintegerat least 0
-
maxItemsinteger -
addItemCaptionstringat most 64 characters
-
itemCaptionstringat most 100 characters
-
itemModestringnoHeaderdraggable
-
-
pagesobject[]3 properties
-
idstring1–24 characters
-
labelstring1–40 characters
-
hintstringat most 280 characters
-
-
submitCaptionstring -
appearanceobject5 properties
-
accentColorstring -
accentTextColorstring -
boxobject6 properties
-
borderobject3 properties
-
widthnumber -
colorstringpattern
^#[0-9A-F]{6,8}$ -
radiusnumber
-
-
backgroundobject1 property
-
colorstringpattern
^#[0-9A-F]{6,8}$
-
-
fontobject3 properties
-
colorstringpattern
^#[0-9A-F]{6,8}$ -
sizenumberat least 1
-
weightnumber
-
-
shadowsobject[]5 properties
-
xnumber -
ynumber -
blurnumberat least 0
-
spreadnumberat least 0
-
colorstringpattern
^#[0-9A-F]{6,8}$
-
-
paddingobject4 properties
-
leftnumberat least 0
-
rightnumberat least 0
-
topnumberat least 0
-
bottomnumberat least 0
-
-
marginobject4 properties
-
leftnumberat least 0
-
rightnumberat least 0
-
topnumberat least 0
-
bottomnumberat least 0
-
-
-
groupBoxobject6 properties
-
borderobject3 properties
-
widthnumber -
colorstringpattern
^#[0-9A-F]{6,8}$ -
radiusnumber
-
-
backgroundobject1 property
-
colorstringpattern
^#[0-9A-F]{6,8}$
-
-
fontobject3 properties
-
colorstringpattern
^#[0-9A-F]{6,8}$ -
sizenumberat least 1
-
weightnumber
-
-
shadowsobject[]5 properties
-
xnumber -
ynumber -
blurnumberat least 0
-
spreadnumberat least 0
-
colorstringpattern
^#[0-9A-F]{6,8}$
-
-
paddingobject4 properties
-
leftnumberat least 0
-
rightnumberat least 0
-
topnumberat least 0
-
bottomnumberat least 0
-
-
marginobject4 properties
-
leftnumberat least 0
-
rightnumberat least 0
-
topnumberat least 0
-
bottomnumberat least 0
-
-
-
inputBoxobject8 properties
-
borderobject3 properties
-
widthnumber -
colorstringpattern
^#[0-9A-F]{6,8}$ -
radiusnumber
-
-
backgroundobject1 property
-
colorstringpattern
^#[0-9A-F]{6,8}$
-
-
fontobject3 properties
-
colorstringpattern
^#[0-9A-F]{6,8}$ -
sizenumberat least 1
-
weightnumber
-
-
shadowsobject[]5 properties
-
xnumber -
ynumber -
blurnumberat least 0
-
spreadnumberat least 0
-
colorstringpattern
^#[0-9A-F]{6,8}$
-
-
paddingobject4 properties
-
leftnumberat least 0
-
rightnumberat least 0
-
topnumberat least 0
-
bottomnumberat least 0
-
-
marginobject4 properties
-
leftnumberat least 0
-
rightnumberat least 0
-
topnumberat least 0
-
bottomnumberat least 0
-
-
labelFontobject3 properties
-
colorstringpattern
^#[0-9A-F]{6,8}$ -
sizenumberat least 1
-
weightnumber
-
-
heightnumberat least 0
-
-
-
validationsobject[]2 properties
-
conditionobject2 properties
-
operatorstringandor -
conditions(object (recursive) | object)[]at least 1 items
4 properties
-
leftobject | object of anyVariant 1: 1 property
-
variablestringat least 1 characters
Variant 2: 4 properties
-
sourceobject1 property
-
variablestringat least 1 characters
-
-
lookupobjectnullable1 property
-
variablestringat least 1 characters
-
-
arrayboolean -
selectobject (recursive)
Variant 3: 2 properties
-
funcstring33 values
concatifEmptylowercaseuppercasesubstringtrimabsceilfloorminmaxmodsumsubmuldivavgmedparseNumberformatNumberdateOnlydateTimedateOnlyPartdateTimePartagedateOnlyDifferencedateTimeDifferencesetDateOnlysetDateTimeaddDateOnlyaddDateTimeformatDateOnlyformatDateTime -
paramsobject (recursive)[]
Variant 4: 1 property
-
literalnumber[] | number
Variant 5: 3 properties
-
ifobject (recursive) -
thenobject (recursive) -
elseobject (recursive)
-
-
cmpFuncstring15 values
eqisSetltltegtgteincludescontainsstartsWithendsWithbeforebeforeAtafterafterAtisToday -
rightobject | object of anyVariant 1: 1 property
-
variablestringat least 1 characters
Variant 2: 4 properties
-
sourceobject1 property
-
variablestringat least 1 characters
-
-
lookupobjectnullable1 property
-
variablestringat least 1 characters
-
-
arrayboolean -
selectobject (recursive)
Variant 3: 2 properties
-
funcstring33 values
concatifEmptylowercaseuppercasesubstringtrimabsceilfloorminmaxmodsumsubmuldivavgmedparseNumberformatNumberdateOnlydateTimedateOnlyPartdateTimePartagedateOnlyDifferencedateTimeDifferencesetDateOnlysetDateTimeaddDateOnlyaddDateTimeformatDateOnlyformatDateTime -
paramsobject (recursive)[]
Variant 4: 1 property
-
literalnumber[] | number
Variant 5: 3 properties
-
ifobject (recursive) -
thenobject (recursive) -
elseobject (recursive)
-
-
negateboolean
-
-
-
messagestring1–500 characters
-
-
-
statusesobject[]2–100 items
6 properties
-
_idid -
labelstring1–80 characters
-
colorstring22 values
slategrayzincneutralstoneredorangeamberyellowlimegreenemeraldtealcyanskyblueindigovioletpurplefuchsiapinkrose -
rolestringregularreviewcompleted -
orderintegerat least 0
-
archivedAtstring · date-timenullable
-
-
typesobject[]1–50 items
7 properties
-
_idid -
namestring1–80 characters
-
emojistringat most 16 characters
-
orderintegerat least 0
-
archivedAtstring · date-timenullable -
statusesid[]2–30 items
-
statusTransitionsobject[]nullableat most 30 items
2 properties
-
fromStatusid -
toStatusesid[]1–30 items
-
-
-
-
countintegerat least 0
{
"topics": [
{
"_id": "000000000000000000000001",
"organization": "000000000000000000000001",
"name": "string",
"identifier": "string",
"lastSequenceNumber": 0,
"color": "slate",
"description": "string",
"revision": 0,
"openCount": 0,
"closedCount": 0,
"archivedAt": "2026-06-15T22:30:00Z",
"archivedBy": {
"name": "string",
"type": "user",
"userId": "string",
"image": {
"resource": "string"
}
},
"customFields": {
"groups": [
{
"id": "string",
"label": "string",
"fields": [
{
"id": "string",
"type": "placeholder",
"name": "string"
}
]
}
]
},
"statuses": [
{
"_id": "000000000000000000000001",
"label": "string",
"color": "slate",
"role": "regular",
"order": 0,
"archivedAt": "2026-06-15T22:30:00Z"
}
],
"types": [
{
"_id": "000000000000000000000001",
"name": "string",
"emoji": "string",
"order": 0,
"archivedAt": "2026-06-15T22:30:00Z",
"statuses": [
"000000000000000000000001"
],
"statusTransitions": [
{
"fromStatus": "000000000000000000000001",
"toStatuses": [
"000000000000000000000001"
]
}
]
}
]
}
],
"count": 0
}
Errors
No errors of its own are known for this endpoint.
Errors nearly every request can meet are listed under Errors.