ConnectCloud Developers

List the latest NFON sync runs (tenant:settings:read)

GET /api/crm/v1/nfon/sync/runs

Module: CRM · operationId: listNfonSyncRuns · Tag: NFON telephony · Auth: access token (Authorization: Bearer <accessToken>)

The latest runs of the tenant, newest first, manual and scheduled, with the numbers they left out (at most 500 per run are kept). The last 200 runs per tenant are kept.

Parameters

Name In Type Required Description
limit query integer Number of runs, 1–100; any other value is 400 invalid. (default 20; max 100)

Responses

  • 200 Runs (application/json)
  • 400 Invalid input (invalid): field names the first invalid field, details.fields every one (JSON paths for bodies, parameter names for the query). Some refusals have their own code (invalid_sort, invalid_stages, invalid_custom_fields, convert_target_required, invalid_csv, …). (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:

  • items (array of NfonSyncRunLog, required): Runs, newest first.
    • 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 of SUCCESS, FAILED)
    • trigger (string, required): Started by hand or by a schedule. (one of MANUAL, SCHEDULED)
    • type (string, required): FULL: comms empties and rebuilds the NFON phone book. (one of INCREMENTAL, 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 of SKIP)
      • 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) or lead:<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:

{
  "items": [
    {
      "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"
    }
  ]
}

Example request

curl -X GET 'https://api.mbcom.cloud/api/crm/v1/nfon/sync/runs' \
  -H "Authorization: Bearer $ACCESS_TOKEN"

View as Markdown · Interactive reference · OpenAPI