API docs by Redocly

Hrmony Embedded API — Partner (EN) (1.0.0)

Download OpenAPI specification:

License: LicenseRef-Hrmony-Proprietary

Hrmony Embedded API — Partner tier. Do not edit by hand.

Organisationen

Create an organisation

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

Request language surface — de or en.

X-Request-Id
string

Correlation id; echoed on the response.

traceparent
string

W3C trace context.

tracestate
string

W3C trace state.

Idempotency-Key
string

Optional idempotency key for mutating requests.

Request Body schema: application/json
required
externalCustomerId
required
string

Stable customer ID from the partner CRM. Unique per partner account; duplicate results in 409.

name
required
string

Display name of the new organisation.

Responses

Request samples

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

Response samples

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

List organisations for the partner

Authorizations:
clientCredentials
query Parameters
limit
integer >= 1

Page size.

cursor
string

Opaque cursor from meta.pagination.nextCursor.

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

Request language surface — de or en.

X-Request-Id
string

Correlation id; echoed on the response.

traceparent
string

W3C trace context.

tracestate
string

W3C trace state.

Responses

Response samples

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