ConnectCloud Developers

Get the tenant's own company profile (tenant:masterdata:read)

GET /api/masterdata/tenant-profile

Module: Master data · operationId: getTenantProfile · Tag: Settings · Auth: access token (Authorization: Bearer <accessToken>)

404 until the profile was saved once.

Responses

  • 200 The profile (application/json)
  • 401 Missing, invalid or expired token (empty body)
  • 403 The token lacks the permission or carries no tenant (application/json)
  • 404 Not found in the caller's tenant (or merged, see code) (application/json)

Fields of the 200 answer:

  • companyName (string, required): Company name of the tenant (max length 255)
  • version (integer, required): 0 creates the profile; otherwise the version you read
  • city (string): City (max length 128)
  • commercialRegister (string): Commercial register number (max length 128)
  • companyNameAddition (string): Company name addition (max length 255)
  • countryCode (string): Country (ISO 3166-1 alpha-2); decides whether addresses are foreign (default "DE")
  • defaultBankName (string): Name of the default bank (max length 128)
  • defaultBic (string): BIC of the default bank account
  • defaultIban (string): IBAN of the default bank account
  • email (string (email)): E-mail address (max length 255)
  • geocodePrecision (string, read-only): See PostalAddress.geocodePrecision (one of HOUSE, STREET, LOCALITY, POSTCODE)
  • geocodeStatus (string, read-only): See PostalAddress.geocodeStatus (one of PENDING, DONE, FAILED, SKIPPED)
  • glAccountLength (integer, nullable): Length g of the G/L accounts; unset: account numbers of addresses are not checked. Changing it never fails because of existing addresses (max 8)
  • invoiceContactEmail (string (email)): E-mail of the invoice contact (BT-43); empty: invoiceEmail, else email (max length 255)
  • invoiceContactName (string): Contact person outgoing invoices name (XRechnung BT-41, required there) (max length 128)
  • invoiceContactPhone (string): Phone of the invoice contact (BT-42); empty: phone (max length 64)
  • invoiceEmail (string (email)): Electronic address of the seller on outgoing e-invoices (BT-34, scheme EM); empty: email (max length 255)
  • latitude (number, nullable, read-only): WGS 84, geocoded from the address like a postal address (origin of distances); ignored on writes
  • longitude (number, nullable, read-only): WGS 84
  • managingDirectors (string): Managing directors (max length 255)
  • phone (string): Phone (max length 64)
  • postalCode (string): Postal code (max length 32)
  • registerCourt (string): Register court (max length 128)
  • sepaCreditorId (string): SEPA creditor identifier (max length 35)
  • street (string): Street with house number (max length 255)
  • taxNumber (string): Tax number (max length 64)
  • updatedAt (string (date-time), read-only): Time of the last change
  • vatId (string): VAT ID of the tenant (used for official VAT checks)
  • website (string): Website (max length 255)

Example 200 answer:

{
  "city": "Regensburg",
  "commercialRegister": "HRB 99999",
  "companyName": "Muster IT-Systemhaus GmbH",
  "countryCode": "DE",
  "defaultBankName": "Stadtsparkasse München",
  "defaultBic": "SSKMDEMMXXX",
  "defaultIban": "DE66701500000001234567",
  "email": "info@muster-it.example",
  "geocodePrecision": "HOUSE",
  "geocodeStatus": "DONE",
  "glAccountLength": 4,
  "invoiceContactEmail": "christina.adler@muster-it.example",
  "invoiceContactName": "Christina Adler",
  "invoiceContactPhone": "+4994112345015",
  "invoiceEmail": "rechnungen@muster-it.example",
  "latitude": 49.0134,
  "longitude": 12.1325,
  "managingDirectors": "Thomas Pfeiffer",
  "phone": "+49941123450",
  "postalCode": "93055",
  "registerCourt": "Amtsgericht Regensburg",
  "street": "Industriestraße 12",
  "updatedAt": "2026-06-01T10:00:00Z",
  "vatId": "DE999000111",
  "version": 4,
  "website": "https://www.muster-it.example"
}

Example request

curl -X GET 'https://api.mbcom.cloud/api/masterdata/tenant-profile' \
  -H "Authorization: Bearer $ACCESS_TOKEN"

View as Markdown · Interactive reference · OpenAPI