API documentation
User
Tenant
Feature
Entitlement
User & permissions
Settings
- Settings
- Media
- Webhook
- Notification
Payment
- Payment Method
- Transaction
- SEPA XML
- Open Banking
- Bank Account Transaction
Customer
- Customer
- Customer Address
- Customer Email
- Customer Settings
- Customer Otp
Billing
- Invoice
- Invoice Position Item
- Billing Run
Dunning
- Dunning Document
- Dunning Rule
Subscription
- Subscription
- Subscription Item
- Subscription Measurement
- Billing Group
Offers
- Offer
- Offer Recipient
- Offer Template
Catalogue
- Unit
- Measurement
- Product
- Product Family
- Price Plan
- Coupon
Checkout
- Checkout Link
- Cart
Accounting
Tenant
Get a tenant
Retrieves a Tenant resource.
Required permissions:tenant:manager
GET
/
tenants
/
{id}
curl -X GET \
/tenants/{id} \
--header "Authorization: Bearer <token>"
{
"id": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ",
"name": "ACME",
"username": "acme",
"vatNumber": "DE123456789",
"owner": "<any>",
"legalCompanyName": "Acme Inc.",
"city": "Cologne",
"zip": "50667",
"street": "Domstraße",
"housenumber": "1",
"countryCode": "DE",
"website": "https://acme.com",
"commercialRegister": "Berlin Charlottenburg",
"commercialRegisterNumber": "HRB 123456",
"phone": "+49 123 456 789",
"email": "info@acme.de",
"ceo": "Max Mustermann",
"iban": "DE89370400440532013000",
"environment": "sandbox",
"appearance": {
"id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
"logoUrl": "https://example.com/logo.png",
"primaryColor": "#000000",
"secondaryColor": "#000000",
"privacyUrl": "https://example.com/privacy",
"conditionsUrl": "https://example.com/terms-and-conditions",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"documentSettings": {
"id": "<string>",
"logoPosition": "<any>",
"footer": {
"id": "<string>",
"translations": {}
}
},
"timeZone": "Europe/Berlin",
"readOnlyCustomers": true,
"createdAt": "2021-01-01T00:00:00+00:00",
"updatedAt": "2021-01-01T00:00:00+00:00"
}
Authorizations
Value for the Authorization header parameter.
Path Parameters
Tenant identifier
Response
200
application/json
Tenant resource
Was this page helpful?
curl -X GET \
/tenants/{id} \
--header "Authorization: Bearer <token>"
{
"id": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ",
"name": "ACME",
"username": "acme",
"vatNumber": "DE123456789",
"owner": "<any>",
"legalCompanyName": "Acme Inc.",
"city": "Cologne",
"zip": "50667",
"street": "Domstraße",
"housenumber": "1",
"countryCode": "DE",
"website": "https://acme.com",
"commercialRegister": "Berlin Charlottenburg",
"commercialRegisterNumber": "HRB 123456",
"phone": "+49 123 456 789",
"email": "info@acme.de",
"ceo": "Max Mustermann",
"iban": "DE89370400440532013000",
"environment": "sandbox",
"appearance": {
"id": "ad8f1c2c-3b1c-4b0a-8b0a-0b0b0b0b0b0b",
"logoUrl": "https://example.com/logo.png",
"primaryColor": "#000000",
"secondaryColor": "#000000",
"privacyUrl": "https://example.com/privacy",
"conditionsUrl": "https://example.com/terms-and-conditions",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"documentSettings": {
"id": "<string>",
"logoPosition": "<any>",
"footer": {
"id": "<string>",
"translations": {}
}
},
"timeZone": "Europe/Berlin",
"readOnlyCustomers": true,
"createdAt": "2021-01-01T00:00:00+00:00",
"updatedAt": "2021-01-01T00:00:00+00:00"
}
Assistant
Responses are generated using AI and may contain mistakes.