AlphaAlpha Docs

Get tenant summaries with user counts

Get a list of all tenants with their user counts. Restricted to Super Admins.

GET
/tenants/summaries
AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/tenants/summaries"
[
  {
    "tenant": {
      "active": true,
      "billingInfo": {
        "address": {
          "city": "string",
          "country": "string",
          "houseNumber": "string",
          "id": "string",
          "latitude": 0.1,
          "longitude": 0.1,
          "postalCode": "string",
          "street": "string"
        },
        "bank": "string",
        "bic": "string",
        "cocNumber": "string",
        "contacts": [
          {
            "department": "string",
            "email": "string",
            "firstName": "string",
            "id": "string",
            "lastName": "string",
            "phone": "string"
          }
        ],
        "email": "string",
        "iban": "string",
        "phone": "string",
        "type": "COMPANY",
        "vatNumber": "string"
      },
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "domain": "string",
      "id": "string",
      "lightThemeLogo": {
        "blobId": "string",
        "height": 0,
        "thumbnailBlobId": "string",
        "width": 0
      },
      "logo": {
        "blobId": "string",
        "height": 0,
        "thumbnailBlobId": "string",
        "width": 0
      },
      "logoUrl": "string",
      "name": "string",
      "owner": "string",
      "packageNameFromDomain": "string",
      "scopes": {
        "assetManagement": true,
        "buyerGuidance": true,
        "calendar": true,
        "clients": true,
        "communications": true,
        "concepts": true,
        "configurator": true,
        "crm": true,
        "documents": true,
        "environment": true,
        "finance": true,
        "hr": true,
        "inventory": true,
        "production": true,
        "products": true,
        "projects": true,
        "reporting": true,
        "shop": true,
        "subsidiaries": true,
        "suppliers": true,
        "support": true,
        "tasks": true
      },
      "settings": {
        "accentColor": "string",
        "autoAddDomainUsers": true,
        "code": "string",
        "configuratorSettings": {
          "buttonColor": "string",
          "buttonTextColor": "string",
          "collapseCategoriesByDefault": true,
          "layout": "UITGEBREID",
          "lightPointFamily": {
            "blobId": "string",
            "created": "2019-08-24T14:15:22Z",
            "extension": "string",
            "fileSize": 0,
            "name": "string",
            "type": "IMAGE"
          },
          "preserveSourceVerticalPosition": true,
          "primaryColor": "string",
          "primaryTextColor": "string",
          "revitTemplate": {
            "blobId": "string",
            "created": "2019-08-24T14:15:22Z",
            "extension": "string",
            "fileSize": 0,
            "name": "string",
            "type": "IMAGE"
          },
          "revitVersion": "string",
          "showLogo": true,
          "useTenantColor": true,
          "wallOutletFamily": {
            "blobId": "string",
            "created": "2019-08-24T14:15:22Z",
            "extension": "string",
            "fileSize": 0,
            "name": "string",
            "type": "IMAGE"
          }
        },
        "coordinateSystem": "string",
        "defaultCountry": "string",
        "defaultCurrency": "string",
        "defaultLanguage": "string",
        "defaultProductVisibility": "string",
        "defaultTimezone": "string",
        "defaultVat": 0.1,
        "documentSettings": {
          "estimateFooterEn": "string",
          "estimateFooterNl": "string",
          "hideVatColumnWhenUniform": true,
          "invoiceFooterEn": "string",
          "invoiceFooterNl": "string",
          "pdfColumnLabelsEn": {
            "property1": "string",
            "property2": "string"
          },
          "pdfColumnLabelsNl": {
            "property1": "string",
            "property2": "string"
          },
          "pdfColumnOrder": [
            "string"
          ],
          "showClientContactInfo": true,
          "showDiscountLines": true,
          "showRowNumbers": true
        },
        "exchangeRateSyncEnabled": true,
        "financeSettings": {
          "invoiceRemindersEnabled": true
        },
        "productIdPrefix": "string",
        "salesReportRoyaltyPercentage": 0.1,
        "scopeProductsToSubsidiary": true,
        "shopEnabled": true,
        "shopSettings": {
          "bannerImageId": "string",
          "bannerSubtitle": "string",
          "bannerTitle": "string",
          "enabledPaymentMethods": [
            "INVOICE"
          ],
          "freeShippingThreshold": 0.1,
          "heroImageId": "string",
          "postnlApiKey": "string",
          "postnlCollectionLocation": "string",
          "postnlCustomerNumber": "string",
          "returnPolicy": "string",
          "shippingFlatRate": 0.1,
          "shopDescription": "string",
          "termsAndConditions": "string"
        },
        "tcsPdf": {
          "blobId": "string",
          "created": "2019-08-24T14:15:22Z",
          "extension": "string",
          "fileSize": 0,
          "name": "string",
          "type": "IMAGE"
        }
      },
      "subscription": "TRIAL",
      "subscriptionExpires": "2019-08-24T14:15:22Z",
      "tenantRoles": [
        {
          "description": "string",
          "name": "string",
          "permissions": {
            "appPermissions": [
              "CREATE_APIKEYS"
            ],
            "assetManagementPermissions": [
              "CREATE_ASSETS"
            ],
            "calendarPermissions": [
              "CREATE_CALENDAR_EVENTS"
            ],
            "communicationsPermissions": [
              "CREATE_TEMPLATES"
            ],
            "configuratorPermissions": [
              "CREATE_CONCEPTS"
            ],
            "crmPermissions": [
              "CREATE_LEADS"
            ],
            "documentPermissions": [
              "CREATE_DOCUMENTS"
            ],
            "financePermissions": [
              "CREATE_CLIENTS"
            ],
            "hrPermissions": [
              "CREATE_EMPLOYEES"
            ],
            "inventoryPermissions": [
              "CREATE_INVENTORY"
            ],
            "productionPermissions": [
              "CREATE_PRODUCTION"
            ],
            "productsPermissions": [
              "CREATE_PRODUCTS"
            ],
            "projectsPermissions": [
              "CREATE_PROJECTS"
            ],
            "reportingPermissions": [
              "READ_SALES_REPORTS"
            ]
          }
        }
      ],
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    },
    "userCount": 0
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}