API docs by Redocly

Hrmony Embedded API — Partner (DE) (1.0.0)

Download OpenAPI specification:

License: LicenseRef-Hrmony-Proprietary

Hrmony Embedded API — Partner-Tier. Nicht manuell bearbeiten.

Organisationen

Organisation erstellen

Authorizations:
clientCredentials
header Parameters
Accept-Language
required
string
Enum: "de" "en"

Angeforderte Sprachoberfläche — de oder en.

X-Request-Id
string

Korrelations-ID; wird auf der Antwort wiederholt.

traceparent
string

W3C-Tracekontext.

tracestate
string

W3C-Tracestatus.

Idempotency-Key
string

Optionaler Idempotency-Key für mutierende Anfragen.

Request Body schema: application/json
required
externeKundenId
required
string

Stabile Kunden-ID aus dem Partner-CRM. Eindeutig pro Partner-Account; Duplikat führt zu 409.

name
required
string

Anzeigename der neuen Organisation.

Responses

Request samples

Content type
application/json
{
  • "externeKundenId": "kunde-abc123",
  • "name": "Müller GmbH"
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Organisationen des Partners auflisten

Authorizations:
clientCredentials
query Parameters
limit
integer >= 1

Seitengröße.

cursor
string

Opaker Cursor aus meta.pagination.nextCursor.

header Parameters
Accept-Language
required
string
Enum: "de" "en"

Angeforderte Sprachoberfläche — de oder en.

X-Request-Id
string

Korrelations-ID; wird auf der Antwort wiederholt.

traceparent
string

W3C-Tracekontext.

tracestate
string

W3C-Tracestatus.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}