Tenant
Get the tenants of the current user
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 the tenants of the current user
Retrieves the collection of Tenant resources.
Required permissions:ROLE_USER
GET
/
user
/
tenants
curl -X GET \
/user/tenants \
--header "Authorization: Bearer <token>"
{
"data": [
{
"id": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ",
"name": "ACME",
"username": "acme",
"legalCompanyName": "Acme Inc."
}
],
"meta": {
"pagination": {
"totalItems": 123,
"itemsPerPage": 123,
"currentPage": 123,
"lastPage": 123,
"pageTotalItems": 123
}
}
}
Authorizations
Value for the Authorization header parameter.
Query Parameters
The collection page number
The number of items per page
Required range:
0 <= x <= 100
Response
200
application/json
Tenant collection
Was this page helpful?
curl -X GET \
/user/tenants \
--header "Authorization: Bearer <token>"
{
"data": [
{
"id": "01F9Z3ZJXZQZJZJZJZJZJZJZJZ",
"name": "ACME",
"username": "acme",
"legalCompanyName": "Acme Inc."
}
],
"meta": {
"pagination": {
"totalItems": 123,
"itemsPerPage": 123,
"currentPage": 123,
"lastPage": 123,
"pageTotalItems": 123
}
}
}