Search
Search records
Searches the organization's records for a text, and tolerates typos. It covers contacts, debtors, creditors, receipts, events, groups and Drive files, or only the types you list. You can narrow results with filters on fields and set a limit per type (1 to 20, default 5). It returns records, best match first within each type. Each record has its type, id, title, detail, the params needed to open it, related records and, for contacts, an actor. Only records the caller may read are found, and only by the fields the caller may read. Nothing is changed.
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Who may call it
- Only callers acting for an organization can use this endpoint.
- The caller needs the
mandate.readpermission. - Only records the caller may read are returned. They are matched and shown only by the fields the caller may read. A type in which the caller may read nothing finds nothing.
- When
filtersare given, only types that have every filtered field are searched. A type is also skipped when the caller may not read a filtered field or one of its values. If no type is left,recordsis empty.
Request
Path parameters
-
organizationIdidrequired -
mandateIdidrequired
Body
Content-Type: application/json
-
searchTermstringrequired1–200 characters
-
typesstring[]at least 1 items
contactreceipteventgroupdriveFileattendeebookingconversationcreditordebtordonationresource -
limitinteger1–20 · default
5 -
filtersobject[]at most 5 items · default
[]2 properties
-
fieldstringrequired1–40 characters
-
valuesstring[]required1–20 items · each at most 100 characters
-
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request POST 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/search' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/search", {
method: "POST",
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' => 'POST',
'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/YOUR_MANDATE_ID/search', 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;
No request that worked has been recorded yet, so the body is not shown.
Response
200 Successful response
Content-Type: application/json
-
recordsobject[]7 properties
-
typestringcontactreceipteventgroupdriveFileattendeebookingconversationcreditordebtordonationresource -
idid -
titlestring -
detailstring -
paramsobject of string -
relatedobject of string -
actorobjectnullableIf the caller has neither
contact.readnorreadon any contact type (contact:member,contact:address,contact:customer,contact:sponsor,contact:contributor,contact:employee,contact:supplier), the contact is hidden.records[].actorkeeps only a placeholder name that says the caller lacks permission.records[].actor.contact,records[].actor.imageandrecords[].actor.userbecome null, andrecords[].actor.nameNormalizedandrecords[].actor.nameSortbecome empty.records[].titleshows the same placeholder name.7 properties
-
namestring -
typestring -
nameNormalizedstring -
nameSortstring -
contactidnullable -
imageobjectnullable4 properties
-
resourcestringat least 1 characters
-
fileNamestringat most 128 characters
-
contentTypestringat most 75 characters
-
fileSizeBytesintegerat least 0
-
-
userobjectnullable4 properties
-
namestringIf the caller lacks
user.read, a contact's linked user is hidden unless that user is the caller.records[].actor.user.namebecomes a placeholder name that says the caller lacks permission, andrecords[].actor.user.imagebecomes null. -
typestring -
userIdstring -
imageobjectnullable4 properties
-
resourcestringat least 1 characters
-
fileNamestringat most 128 characters
-
contentTypestringat most 75 characters
-
fileSizeBytesintegerat least 0
-
-
-
-
{
"records": [
{
"type": "contact",
"id": "000000000000000000000001",
"title": "string",
"detail": "string",
"params": {
"key": "string"
},
"related": {
"key": "string"
},
"actor": {
"name": "string",
"type": "contact",
"nameNormalized": "string",
"nameSort": "string",
"contact": "000000000000000000000001",
"image": {
"resource": "string"
},
"user": {
"name": "string",
"type": "user",
"userId": "string",
"image": {
"resource": "string"
}
}
}
}
]
}
Errors
1 rare error, such as when something changes at the same moment
| Status | Error | When |
|---|---|---|
| 500 | Missing organization access | If the caller's access to the organization cannot be determined while the search runs. |
Errors nearly every request can meet are listed under Errors.