Personendaten lesen

Die Endpunkte dieser Endpunktberechtigung finden Sie im Controller "PersonsRead" und "PersonsReadCatalog".

Um lesend auf die Daten der Personen über die API zugreifen zu können, muss die Endpunktberechtigung "Personen lesen" aktiviert werden.

Die Endpunkte der Version 1.2 sind momentan in der Entwicklung und können noch Änderungen erfahren.

Personen abrufen

Version 1.0

---

get

Autorisierungen

Authorization

OAuth2passwordErforderlich

Use username and password.

Token URL:

Abfrageparameter

apiKeystringOptional

limitinteger · int32OptionalExample: 20

offsetinteger · int32Optional

personIdinteger · int32Optional

includeCommunicationbooleanOptionalDefault: false

includeAddressbooleanOptionalDefault: false

includeBankaccountbooleanOptionalDefault: false

Antworten

200

OK

text/plainapplication/jsontext/json

Idinteger · int32Optional

IdNumstring · nullfähigOptional

Namestring · nullfähigOptional

ShortNamestring · nullfähigOptional

IsNaturalPersonbooleanOptional

ValidFromstring · dateOptionalExample: 2026-02-27Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

ValidTostring · date · nullfähigOptionalExample: 2026-02-27Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

get

/openwowi/v1.0/PersonsRead/Persons

HTTPcURLJavaScriptPython

GET /openwowi/v1.0/PersonsRead/Persons HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "Id": 1,
    "IdNum": "text",
    "Name": "text",
    "ShortName": "text",
    "IsNaturalPerson": true,
    "ValidFrom": "2026-02-27",
    "ValidTo": "2026-02-27",
    "LegalPerson": {
      "LongName1": "text",
      "LongName2": "text",
      "VatId": "text",
      "CommercialRegisterNumber": "text",
      "CommercialRegisterTown": "text",
      "ContractPersons": [
        {
          "Id": 1,
          "IdNum": "text",
          "FirstName": "text",
          "LastName": "text"
        }
      ]
    },
    "NaturalPerson": {
      "FirstName": "text",
      "LastName": "text",
      "BirthName": "text",
      "CareOf": "text",
      "Title": "text",
      "BirthDate": "2026-02-27T16:30:19.099Z",
      "DeathDate": "2026-02-27T16:30:19.099Z",
      "Gender": {
        "Id": 1,
        "Name": "text"
      },
      "MaritalType": {
        "Id": 1,
        "Name": "text"
      },
      "Nationality": {
        "Id": 1,
        "Name": "text",
        "Code": "text"
      }
    },
    "Addresses": [
      {
        "AddressTypeId": 1,
        "Zip": "text",
        "Town": "text",
        "Street": "text",
        "HouseNumber": "text",
        "HouseNumberAddition": "text",
        "CountryId": 1,
        "ValidFrom": "2026-02-27",
        "ValidTo": "2026-02-27",
        "Id": 1,
        "AddressType": "text",
        "CountryCode": "text",
        "StreetComplete": "text",
        "HouseNumberComplete": "text",
        "MainAddress": true
      }
    ],
    "Communications": [
      {
        "CommunicationTypeId": 1,
        "RelatedAddressId": 1,
        "Content": "text",
        "Explanation": "text",
        "Id": 1,
        "CommunicationType": "text",
        "RelatedAddress": "text"
      }
    ],
    "PersonBankAccounts": [
      {
        "Id": 1,
        "Iban": "text",
        "Bic": "text",
        "AccountHolder": "text",
        "ValidFrom": "2026-02-27",
        "ValidTo": "2026-02-27",
        "BankAccountType": {
          "Id": 1,
          "Code": "text"
        },
        "BankAccountId": 1,
        "BankAccountUsageType": {
          "Id": 1,
          "Code": "text"
        }
      }
    ]
  }
]

---

Version 1.2

---

get

Autorisierungen

Authorization

OAuth2passwordErforderlich

Use username and password.

Token URL:

Abfrageparameter

apiKeystringOptional

limitinteger · int32OptionalExample: 20

offsetinteger · int32Optional

personIdinteger · int32Optional

includeCommunicationbooleanOptionalDefault: false

includeAddressbooleanOptionalDefault: false

includeBankaccountbooleanOptionalDefault: false

includeAdditionalFieldbooleanOptionalDefault: false

includeContactRelationbooleanOptionalDefault: false

showNullValuesbooleanOptionalDefault: false

Antworten

200

OK

text/plainapplication/jsontext/json

Idinteger · int32Optional

IdNumstring · nullfähigOptional

Namestring · nullfähigOptional

ShortNamestring · nullfähigOptional

ConfidentialbooleanOptional

ValidFromstring · dateOptionalExample: 2026-02-27Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

ValidTostring · date · nullfähigOptionalExample: 2026-02-27Pattern: \d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

get

/openwowi/v1.2/PersonsRead/Persons

HTTPcURLJavaScriptPython

GET /openwowi/v1.2/PersonsRead/Persons HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "Id": 1,
    "IdNum": "text",
    "Name": "text",
    "ShortName": "text",
    "Confidential": true,
    "Vip": {
      "Id": 1,
      "Code": "text"
    },
    "ValidFrom": "2026-02-27",
    "ValidTo": "2026-02-27",
    "LegalPerson": {
      "LongName1": "text",
      "LongName2": "text",
      "VatId": "text",
      "CommercialRegisterNumber": "text",
      "CommercialRegisterTown": "text",
      "ContractPersons": [
        {
          "Id": 1,
          "IdNum": "text",
          "FirstName": "text",
          "LastName": "text"
        }
      ]
    },
    "NaturalPerson": {
      "Title": "text",
      "FirstName": "text",
      "LastName": "text",
      "BirthName": "text",
      "CareOf": "text",
      "BirthDate": "2026-02-27",
      "DeathDate": "2026-02-27T16:30:19.099Z",
      "Gender": {
        "Id": 1,
        "Name": "text"
      },
      "MaritalType": {
        "Id": 1,
        "Name": "text"
      },
      "Nationality": {
        "Id": 1,
        "Name": "text",
        "Code": "text"
      },
      "PersonInCare": {
        "Id": 1,
        "IdNum": "text"
      },
      "ContactFor": [
        {
          "Id": 1,
          "IdNum": "text",
          "LongName1": "text",
          "LongName2": "text"
        }
      ]
    },
    "Addresses": [
      {
        "Id": 1,
        "Zip": "text",
        "Town": "text",
        "Street": "text",
        "HouseNumber": "text",
        "HouseNumberAddition": "text",
        "ValidFrom": "2026-02-27",
        "ValidTo": "2026-02-27",
        "StreetComplete": "text",
        "HouseNumberComplete": "text",
        "MainAddress": true,
        "AddressType": {
          "Id": 1,
          "Name": "text"
        },
        "Country": {
          "Id": 1,
          "Name": "text",
          "Code": "text"
        }
      }
    ],
    "Communications": [
      {
        "Id": 1,
        "RelatedAddressId": 1,
        "Content": "text",
        "Explanation": "text",
        "RelatedAddress": "text",
        "CommunicationType": {
          "Id": 1,
          "Name": "text"
        }
      }
    ],
    "PersonBankAccounts": [
      {
        "Id": 1,
        "Iban": "text",
        "Bic": "text",
        "AccountHolder": "text",
        "ValidFrom": "2026-02-27",
        "ValidTo": "2026-02-27",
        "BankAccountType": {
          "Id": 1,
          "Code": "text"
        },
        "BankAccountId": 1,
        "BankAccountUsageType": {
          "Id": 1,
          "Code": "text"
        }
      }
    ],
    "AdditionalFields": [
      {
        "Name": "text",
        "Content": "text",
        "Type": "text"
      }
    ]
  }
]

---

Personen "Zuordnungen" abrufen

Version 1.2

---

get

Autorisierungen

Authorization

OAuth2passwordErforderlich

Use username and password.

Token URL:

Pfadparameter

personIdinteger · int32Erforderlich

Abfrageparameter

apiKeystringOptional

showNullValuesbooleanOptionalDefault: false

Antworten

200

OK

text/plainapplication/jsontext/json

EntityCodestring · nullfähigOptional

EntityNamestring · nullfähigOptional

EntityIdinteger · int32 · nullfähigOptional

TextInfosstring[] · nullfähigOptional

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

get

/openwowi/v1.2/PersonsRead/Person/{personId}/Assignments

HTTPcURLJavaScriptPython

GET /openwowi/v1.2/PersonsRead/Person/{personId}/Assignments HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "EntityCode": "text",
    "EntityName": "text",
    "EntityId": 1,
    "TextInfos": [
      "text"
    ],
    "Relations": [
      {
        "EntityId": 1,
        "EntityCode": "text",
        "DisplayText": "text"
      }
    ]
  }
]

---

Banken

Version 1.2

---

get

Autorisierungen

Authorization

OAuth2passwordErforderlich

Use username and password.

Token URL:

Abfrageparameter

apiKeystringOptional

limitinteger · int32OptionalExample: 20

offsetinteger · int32Optional

bankIdinteger · int32Optional

bicstringOptional

includeObsoletebooleanOptionalDefault: false

showNullValuesbooleanOptionalDefault: false

Antworten

200

OK

text/plainapplication/jsontext/json

Idinteger · int32Optional

Namestring · nullfähigOptional

Codestring · nullfähigOptional

Bicstring · nullfähigOptional

Checksumstring · nullfähigOptional

OwnCodestring · nullfähigOptional

Townstring · nullfähigOptional

Zipstring · nullfähigOptional

IsObsoletebooleanOptional

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

get

/openwowi/v1.2/PersonsRead/Banks

HTTPcURLJavaScriptPython

GET /openwowi/v1.2/PersonsRead/Banks HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "Id": 1,
    "Name": "text",
    "Code": "text",
    "Bic": "text",
    "Checksum": "text",
    "OwnCode": "text",
    "Town": "text",
    "Zip": "text",
    "IsObsolete": true,
    "Country": {
      "Id": 1,
      "Name": "text",
      "Code": "text"
    }
  }
]

---

SEPA Mandate

Version 1.2

---

get

Autorisierungen

Authorization

OAuth2passwordErforderlich

Use username and password.

Token URL:

Abfrageparameter

apiKeystringOptional

limitinteger · int32OptionalExample: 20

offsetinteger · int32Optional

bankAccountIdinteger · int32Optional

licenseAgreementIdinteger · int32Optional

ValidFromstring · date-timeOptional

ValidTostring · date-timeOptional

showNullValuesbooleanOptionalDefault: false

Antworten

200

OK

text/plainapplication/jsontext/json

Idinteger · int32Optional

MandateIdstring · nullfähigOptional

OriginalCreditorNamestring · nullfähigOptional

FormerlyDirectDebitbooleanOptional

ValidFromstring · date-timeOptional

ValidTostring · date-time · nullfähigOptional

MultiplePaymentModesbooleanOptional

IsActivebooleanOptional

DateOfSignaturestring · date-time · nullfähigOptional

PlaceOfSignaturestring · nullfähigOptional

SepaCreditorIdentifierIdinteger · int32Optional

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

get

/openwowi/v1.2/PersonsRead/SepaMandate

HTTPcURLJavaScriptPython

GET /openwowi/v1.2/PersonsRead/SepaMandate HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "Id": 1,
    "MandateId": "text",
    "OriginalCreditorName": "text",
    "BankAccount": {
      "Id": 1,
      "Iban": "text",
      "Bic": "text"
    },
    "SepaMandateType": {
      "Id": 1,
      "Code": "text"
    },
    "FormerlyDirectDebit": true,
    "ValidFrom": "2026-02-27T16:30:19.099Z",
    "ValidTo": "2026-02-27T16:30:19.099Z",
    "MultiplePaymentModes": true,
    "IsActive": true,
    "DateOfSignature": "2026-02-27T16:30:19.099Z",
    "PlaceOfSignature": "text",
    "Address": {
      "Id": 1,
      "Zip": "text",
      "Town": "text",
      "Street": "text",
      "HouseNumber": "text",
      "HouseNumberAddition": "text",
      "ValidFrom": "2025-10-20",
      "ValidTo": "2025-10-20",
      "StreetComplete": "text",
      "HouseNumberComplete": "text",
      "MainAddress": true,
      "AddressType": {
        "Id": 1,
        "Name": "text"
      },
      "Country": {
        "Id": 1,
        "Name": "text",
        "Code": "text"
      }
    },
    "SepaCreditorIdentifierId": 1
  }
]

---

SEPA Gläubiger

Version 1.2

---

get

Autorisierungen

Authorization

OAuth2passwordErforderlich

Use username and password.

Token URL:

Abfrageparameter

apiKeystringOptional

limitinteger · int32OptionalExample: 20

offsetinteger · int32Optional

idinteger · int32Optional

idNumstringOptional

showNullValuesbooleanOptionalDefault: false

Antworten

200

OK

text/plainapplication/jsontext/json

Idinteger · int32Optional

IdNumstring · nullfähigOptional

Descriptionstring · nullfähigOptional

NodeIdinteger · int32Optional

400

Bad Request

text/plainapplication/jsontext/json

401

Unauthorized

get

/openwowi/v1.2/PersonsRead/SepaCreditorIdentifier

HTTPcURLJavaScriptPython

GET /openwowi/v1.2/PersonsRead/SepaCreditorIdentifier HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "Id": 1,
    "IdNum": "text",
    "Description": "text",
    "NodeId": 1
  }
]

---

Enumeratoren für "MaritalTypeId":

ID	Type
1	Single
2	Married
3	CivilPartnered
4	Divorced
5	Widowed
6	InACommune
7	Separated
8	SeparatedCivilPartner
9	SurvivingCivilPartner
10	MaritalStatusUnknown