Zum Inhalt springen
RedcheckStartseite
REST-API / Kunden

Kunden

Eine Agentur ordnet ihre Domains Kunden zu. Die Zuordnung gruppiert die Domainliste und die Nutzung. Eine Mandantengrenze ist sie nicht: Die Agentur bleibt eine Organisation, und jeder Schlüssel sieht alle Kunden.

Auflisten

GEThttps://api.red-check.de/v1/clients

q
string
–
include_archived
boolean
–
limit
integer
–
cursor
string
Undurchsichtiger Zeiger aus `next_cursor` der vorigen Seite.
Anfrage
curl -X GET https://api.red-check.de/v1/clients \
  -H "Authorization: Bearer rc_live_••••••••"

Die Liste ist seitenweise, wie unter Konventionen beschrieben. include_archived=true nimmt archivierte Kunden mit auf.

id
uuidPflicht
–
name
stringPflicht
–
contact_email
string
–
note
string
–
domain_count
integerPflicht
–
archived_at
string | null
–
created_at
string (date-time)
–
Ein Eintrag aus items
{
  "id": "3f9a1c20-5e4b-4d8a-9a11-0c21e7b4c21e",
  "name": "",
  "contact_email": "",
  "note": "",
  "domain_count": 0,
  "archived_at": "2026-09-03T09:14:22Z",
  "created_at": "2026-09-03T09:14:22Z"
}
200
Kunden.
400
Eingabe ungültig (`validation_failed`).
401
Nicht angemeldet (`unauthenticated`) oder zweiter Faktor nicht erbracht (`totp_required`).

Domains zuordnen

Die Zuordnung steht an der Domain. Setzen Sie client_id beim Anlegen oder über PATCH /v1/domains/{id}. null hebt sie auf. Das geht mit jedem Schlüssel, der schreiben darf.

Beim Buchen eines Laufs kopiert Redcheck den Kundennamen in die Abrechnungszeile. Wird ein Kunde später umbenannt, behalten bereits gebuchte Läufe den alten Namen.

Anlegen, ändern, archivieren

POSThttps://api.red-check.de/v1/clients

PATCHhttps://api.red-check.de/v1/clients/{id}

DELETEhttps://api.red-check.de/v1/clients/{id}

DELETE archiviert den Kunden, es löscht ihn nicht. Seine Domains behalten den Kundennamen, gebuchte Läufe bleiben zuordenbar, und in der Auswahl erscheint er nicht mehr.

name
stringPflicht
–
contact_email
string
–
note
string
–