GET
/
organizations
List Orgs
curl --request GET \
  --url https://api.example.com/organizations \
  --header 'Authorization: Bearer <token>'
[
  {
    "registrationCountry": "DE",
    "legalName": "<string>",
    "address": {
      "id": "<string>",
      "address": "<string>",
      "components": {
        "formatted_address": "<string>",
        "street_number": "<string>",
        "road": "<string>",
        "city": "<string>",
        "state": "<string>",
        "country": "<string>",
        "postal_code": "<string>",
        "postal_code_suffix": "<string>",
        "latitude": 123,
        "longitude": 123
      },
      "content": {
        "normalizedAddress": "<string>",
        "countryCode": "DE",
        "addressType": "HAUSANSCHRIFT"
      }
    },
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "workSites": [
      {
        "name": "<string>",
        "address": {
          "id": "<string>",
          "address": "<string>",
          "components": {
            "formatted_address": "<string>",
            "street_number": "<string>",
            "road": "<string>",
            "city": "<string>",
            "state": "<string>",
            "country": "<string>",
            "postal_code": "<string>",
            "postal_code_suffix": "<string>",
            "latitude": 123,
            "longitude": 123
          },
          "content": {
            "normalizedAddress": "<string>",
            "countryCode": "DE",
            "addressType": "HAUSANSCHRIFT"
          }
        },
        "isActive": true,
        "isPrimary": true,
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "validFrom": "2023-12-25",
        "validTo": "2023-12-25",
        "correspondenceAddress": {
          "id": "<string>",
          "address": "<string>",
          "components": {
            "formatted_address": "<string>",
            "street_number": "<string>",
            "road": "<string>",
            "city": "<string>",
            "state": "<string>",
            "country": "<string>",
            "postal_code": "<string>",
            "postal_code_suffix": "<string>",
            "latitude": 123,
            "longitude": 123
          },
          "content": {
            "normalizedAddress": "<string>",
            "countryCode": "DE",
            "addressType": "HAUSANSCHRIFT"
          }
        },
        "orgId": "<string>",
        "contacts": [
          {
            "name": "<string>",
            "id": "<string>",
            "email": "jsmith@example.com",
            "phone": {
              "phoneNumber": "<string>",
              "phoneType": "mobile"
            },
            "roles": []
          }
        ],
        "taxIdentifiers": {
          "id": 123,
          "validFrom": "2023-12-25",
          "validTo": "2023-12-25",
          "taxData": {
            "country": "<string>",
            "businessType": "Sole Trader",
            "payeReferenceNumber": "<string>",
            "accountsOfficeReference": "<string>",
            "validFrom": "2023-12-25",
            "validTo": "2023-12-25"
          }
        },
        "insuranceData": {
          "id": 123,
          "validFrom": "2023-12-25",
          "validTo": "2023-12-25",
          "insuranceCountry": "DE",
          "worksiteLocationNumber": "98797889",
          "accidentInsuranceCompanyNumber": "98797889",
          "accidentInsurancePin": "DE-WS-PIN-456",
          "payrollServiceProviderNumber": "98797889",
          "payrollProcessingLocationNumber": "98797889"
        }
      }
    ],
    "bankAccounts": [
      {
        "financialInstitutionName": "<string>",
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "accountNumber": "DE: DE89370400440532013000",
        "routingNumber": "DE: 370400440",
        "iban": "DE: DE89370400440532013000",
        "swiftCode": "DE: COBADEFFXXX",
        "isActive": true,
        "isPrimary": false
      }
    ],
    "preferences": {
      "id": 123,
      "validFrom": "2023-12-25",
      "validTo": "2023-12-25",
      "isInsolvent": false,
      "insolvencyStartDate": "2023-12-25",
      "insolvencyEndDate": "2023-12-25",
      "insolvencyCompanyNumber": "<string>",
      "insuranceSubsidyMethod": "remuneration",
      "extraPaidLeaveDays": 123,
      "firstPayrollDate": "2023-12-25",
      "lastPayrollDate": "2023-12-25",
      "firstPayrollIntermezzo": "2023-12-25",
      "preferencesCountry": "DE",
      "insuranceCreditPreference": "<string>",
      "daysForSicknessCertificate": 4,
      "additionalChildcareSickDaysReason": 0
    },
    "validFrom": "2023-12-25",
    "validTo": "2023-12-25",
    "correspondenceAddress": {
      "id": "<string>",
      "address": "<string>",
      "components": {
        "formatted_address": "<string>",
        "street_number": "<string>",
        "road": "<string>",
        "city": "<string>",
        "state": "<string>",
        "country": "<string>",
        "postal_code": "<string>",
        "postal_code_suffix": "<string>",
        "latitude": 123,
        "longitude": 123
      },
      "content": {
        "normalizedAddress": "<string>",
        "countryCode": "DE",
        "addressType": "HAUSANSCHRIFT"
      }
    },
    "dbaName": "<string>",
    "incorporationDate": "2023-12-25",
    "website": "<string>",
    "externalRef": "<string>",
    "shutdownDate": "2023-12-25",
    "contacts": [
      {
        "name": "<string>",
        "id": "<string>",
        "email": "jsmith@example.com",
        "phone": {
          "phoneNumber": "<string>",
          "phoneType": "mobile"
        },
        "roles": []
      }
    ],
    "taxIdentifiers": {
      "id": 123,
      "validFrom": "2023-12-25",
      "validTo": "2023-12-25",
      "taxData": {
        "country": "<string>",
        "businessType": "Sole Trader",
        "payeReferenceNumber": "<string>",
        "accountsOfficeReference": "<string>",
        "validFrom": "2023-12-25",
        "validTo": "2023-12-25"
      }
    },
    "insuranceData": {
      "id": 123,
      "validFrom": "2023-12-25",
      "validTo": "2023-12-25",
      "insuranceCountry": "DE",
      "companyNumber": "98797889",
      "unrs": "DE987654321",
      "accidentInsuranceCompanyNumber": "98797889",
      "accidentInsurancePin": "12345",
      "payrollServiceProviderNumber": "98797889",
      "payrollProcessingLocationNumber": "98797889",
      "economicSector": 1,
      "u1Selected": false,
      "u2Selected": false,
      "u3Selected": false,
      "agencyId": "<string>",
      "alternateAgencyId": "<string>",
      "contactId": "<string>"
    },
    "sepaMandates": [
      {
        "creditorId": "<string>",
        "bankAccountId": "<string>",
        "isRecurring": true,
        "id": "<string>",
        "createdBy": "<string>",
        "validFrom": "2023-12-25",
        "validTo": "2023-12-25",
        "mandateReference": "<string>"
      }
    ]
  }
]

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

Successful Response

registrationCountry
enum<string>
required

Enum for CountryAlpha2 codes

Available options:
DE,
IE,
GB,
US,
GB
address
AddressResponse · object
required
id
string
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
workSites
WorksiteResponse · object[] | null
required
bankAccounts
BankAccountResponse · object[] | null
required
preferences
GermanyOrganizationPreferencesResponse · object
required
validFrom
string<date> | null
validTo
string<date> | null
correspondenceAddress
AddressResponse · object
dbaName
string | null
incorporationDate
string<date> | null
website
string | null
externalRef
string | null
Maximum string length: 255
shutdownDate
string<date> | null
contacts
ContactResponse · object[] | null
taxIdentifiers
TaxIdentifiersResponse · object
insuranceData
GermanyOrganizationInsuranceDetailsResponse · object
sepaMandates
SepaMandateResponse · object[]