Aktivitäten – API-Referenz

Aktivitätsprotokoll

GET/api/v1/activities

Verlauf über alle Objekte, neueste zuerst: automatische Einträge (source: history – Phasenwechsel, Zahlungen, Briefe, Recherche …) und protokollierte Aktionen (source: activity). Filter nach Kontakt, Forderung, Objekttyp und Zeitraum.

Berechtigung: activity:read

Query-Parameter

contactIdstring
max. 128 Zeichen
debtIdstring
max. 128 Zeichen
entityTypeenum
Werte: contact, debt, invoice, offer, project, receipt, document, other
source"history" | "activity"
fromstring (date)
ab Datum (einschließlich)
tostring (date)
bis Datum (einschließlich)
limitinteger
Anzahl Einträge (1–100)
1–100 · Standard: 25
cursorstring
`nextCursor` der vorherigen Seite
max. 500 Zeichen

Antwort 200

object"list"Pflicht
dataArray<Activity>Pflicht
- idstringPflicht
- object"activity"Pflicht
- source"history" | "activity"Pflicht
  history = automatischer Verlauf, activity = protokollierte Aktion
- entityTypeenumPflicht
  Werte: contact, debt, invoice, offer, project, receipt, document, other
- entityIdstringPflicht
- contactIdstring | nullPflicht
- debtIdstring | nullPflicht
- actionstringPflicht
- descriptionstringPflicht
- performedBystring | nullPflicht
- metadataobject | nullPflicht
- createdAtstring (date-time)Pflicht
  Zeitpunkt (ISO 8601)
hasMorebooleanPflicht
nextCursorstring | nullPflicht

Mögliche Fehler: 400, 401, 403, 429, 500

curl 'https://www.debt-flow.io/api/v1/activities' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY"

Antwort 200

{
  "object": "list",
  "data": [
    {
      "id": "string",
      "object": "activity",
      "source": "history",
      "entityType": "contact",
      "entityId": "string",
      "contactId": "string",
      "debtId": "string",
      "action": "string",
      "description": "string",
      "performedBy": "string",
      "metadata": {},
      "createdAt": "2026-11-01T09:30:00.000Z"
    }
  ],
  "hasMore": false,
  "nextCursor": "string"
}

Aktivität protokollieren

POST/api/v1/activities

Eigener Eintrag im Aktivitätsprotokoll, z. B. aus einem CRM. Kontakte und Forderungen müssen existieren.

Berechtigung: activity:write

Header

Idempotency-Keystring
Eindeutiger Schlüssel (8–255 Zeichen). Wiederholte Anfragen mit gleichem Schlüssel liefern 24 h lang dieselbe Antwort.
max. 255 Zeichen

Body (JSON) · ActivityCreate

entityTypeenumPflicht
Werte: contact, debt, invoice, offer, project, receipt, document, other
entityIdstringPflicht
max. 128 Zeichen
actionstringPflicht
max. 100 Zeichen
descriptionstring
max. 2000 Zeichen · Standard: ""
metadataobject

Antwort 201 · Activity

idstringPflicht
object"activity"Pflicht
source"history" | "activity"Pflicht
history = automatischer Verlauf, activity = protokollierte Aktion
entityTypeenumPflicht
Werte: contact, debt, invoice, offer, project, receipt, document, other
entityIdstringPflicht
contactIdstring | nullPflicht
debtIdstring | nullPflicht
actionstringPflicht
descriptionstringPflicht
performedBystring | nullPflicht
metadataobject | nullPflicht
createdAtstring (date-time)Pflicht
Zeitpunkt (ISO 8601)

Mögliche Fehler: 400, 401, 403, 404, 409, 422, 429, 500

curl -X POST 'https://www.debt-flow.io/api/v1/activities' \
  -H "Authorization: Bearer $DEBTFLOW_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "entityType": "contact",
  "entityId": "string",
  "action": "string",
  "description": "",
  "metadata": {}
}'

Antwort 201

{
  "id": "string",
  "object": "activity",
  "source": "history",
  "entityType": "contact",
  "entityId": "string",
  "contactId": "string",
  "debtId": "string",
  "action": "string",
  "description": "string",
  "performedBy": "string",
  "metadata": {},
  "createdAt": "2026-11-01T09:30:00.000Z"
}