NFON sync status and entry counts (tenant:settings:read)
GET /api/crm/v1/nfon/sync/status
Module: CRM · operationId: getNfonSyncStatus · Tag: NFON telephony · Auth: access token (Authorization: Bearer <accessToken>)
Served from the run log; it never calls comms or NFON. totalEntries is the number of
entries of the latest run that was sent. lastSync is the most recently logged run,
lastCheckTime the start of the latest run, or the time a scheduled run found nothing new.
Responses
- 200 Status (
application/json) - 401 Missing, invalid or expired token (no body).
- 403 The token lacks the permission (
insufficient permissions) or has no active tenant. (application/json) - 500 Unexpected error; details are only logged. (
application/json)
Fields of the 200 answer:
active(boolean, required): Whether the phone book is active.isSyncing(boolean, required): A run of the tenant is running on some instance.totalEntries(integer, required): Entries of the latest run that was sent.lastCheckTime(string (date-time)): Start of the latest run, or the time a scheduled run found nothing new.lastFullSyncTime(string (date-time)): Start of the most recent full sync.lastSync(NfonSyncRunLog)chunks(integer, required): Parts the entries were sent in (500 entries each).durationMs(integer (int64), required): Duration in milliseconds.endTime(string (date-time), required): End of the run.entries(integer, required): Phone book entries sent.skipped(integer, required): Numbers that could not be normalised.startTime(string (date-time), required): Start of the run.status(string, required):SUCCESS: the phone book was sent to comms;FAILED: nothing was sent (error). (one ofSUCCESS,FAILED)trigger(string, required): Started by hand or by a schedule. (one ofMANUAL,SCHEDULED)type(string, required):FULL: comms empties and rebuilds the NFON phone book. (one ofINCREMENTAL,FULL)entryErrors(array of NfonSyncEntryError): Numbers left out (at most 500 are kept); omitted when none.action(string, required):SKIP: the number could not be normalised and is not in the phone book. (one ofSKIP)message(string, required): Why the number was left out.displayName(string): Name of the contact the number belongs to.number(string): The number as stored.sourceId(string): The contact the number comes from:address:<id>,contact:<id>(masterdata) orlead:<id>.
error(string): Why the run failed; omitted when it was sent.errors(array of string): The run-level error; omitted when none.id(string): Run ID (a decimal number as string).runId(string (uuid)): The run as comms knows it (a UUIDv7); omitted for a failed run.
Example 200 answer:
{
"active": true,
"isSyncing": false,
"lastCheckTime": "2026-11-18T06:00:00Z",
"lastFullSyncTime": "2026-11-15T02:00:00Z",
"lastSync": {
"chunks": 1,
"durationMs": 1834,
"endTime": "2026-11-18T06:00:01Z",
"entries": 122,
"entryErrors": [
{
"action": "SKIP",
"displayName": "Max Muster (Bergmann Bürobedarf KG)",
"message": "Rufnummer kann nicht in das internationale Format (E.164) gebracht werden",
"number": "0941/600700 Zentrale",
"sourceId": "contact:7c9e6679-7425-40de-944b-e07fc1f90ae7"
}
],
"id": "4711",
"runId": "01a1c67f-4f22-7d4d-9670-e186b38b7055",
"skipped": 1,
"startTime": "2026-11-18T06:00:00Z",
"status": "SUCCESS",
"trigger": "SCHEDULED",
"type": "INCREMENTAL"
},
"totalEntries": 122
}
Example request
curl -X GET 'https://api.mbcom.cloud/api/crm/v1/nfon/sync/status' \
-H "Authorization: Bearer $ACCESS_TOKEN"