Crm · Work hours
Export work hours entries
Exports the work hours entries of the accounts the accounts list shows, as CSV or Excel, newest work first: of a period or all periods, optionally filtered by rule, the name of the contact or group, a property filter on the accounts and a selection of accounts. Users limited to their assigned entries only get those. Large exports are queued and sent as a notification once ready. Helper names are left out without access to contacts, submitter and approver names without access to users.
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Permission checks in detail
Required permissions
mandate.readworkHours.read
Also checked, depending on the request and the records it touches
contact.readcontact:member.readcontact:address.readcontact:customer.readcontact:sponsor.readcontact:contributor.readcontact:employee.readcontact:supplier.readuser.read
Request
Path parameters
-
organizationIdidrequired -
mandateIdidrequired
Body
Content-Type: application/json
-
formatstringrequiredcsvxlsx -
formatOptionsobject1 property
-
xlsxobject2 properties
-
arrayFormatstringlinecommacolumns -
unmergedGroupHeaderboolean
-
-
-
propertyPathsstring[]1–1000 items · each at least 1 characters
-
selectionobject2 properties
-
excludeIdsid[]1–1000 items
-
idsid[]1–1000 items
-
-
periodFromstring -
allPeriodsbooleandefault
false -
ruleIdid -
searchstringat most 100 characters
-
userFilterstringnullableA stringified json object representing a property filter
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request POST 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/crm/work-hours/entries/export' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/crm/work-hours/entries/export", {
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/crm/work-hours/entries/export', 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
object
{
"state": "empty"
}
Errors
No errors of its own are known for this endpoint.
Errors nearly every request can meet are listed under Errors.