API · v1 · stabil
CODEMETA OSDeveloper Center
Konsole öffnen

List parties

GET/v1/parties

List parties for the active tenant.

Datenmodell

Diese Operation arbeitet auf der Entität Party (party). Alle 56 Felder — Typ, Validierung, Pflichtangabe, Beziehungen — stehen in der Schema-Referenz.

  • Pflichtfelder: partyType, name, displayName
  • Server-verwaltet: _id, schema, schemaVersion, tenantId, version, createdAt, updatedAt, createdBy, updatedBy, deletedAt, deletedBy, churnedAt, lostAt, datevDebitorenkonto, datevKreditorenkonto, billingBlock.blockedAt, billingBlock.blockedBy, serviceBlock.blockedAt, serviceBlock.blockedBy, inheritedResponsibleUserIds, inheritedTeamIds — diese Felder vergibt die Plattform; im Request werden sie verworfen.

Query-Parameter

NameTypBeschreibung
cursorstring
limitnumber
includeDeletedboolean

Beispiel

curl -X GET https://api.codemeta-os.de/v1/parties \
  -H "X-Tenant-Id: $TENANT" \
  -b cookies.txt
const result = await cm.parties.list();

Antwortcodes

HTTP Bedeutung
200 Default Response

Suche