List

GET 
/listTenants

Returns the sub-tenants of the API key's tenant.

Responses

200

The sub-tenants of the API key's tenant.

application/json

Schema

Schema

success booleanrequired

Whether the request was successful or not.

tenants

object[]

List of sub-tenants of the API key's tenant.

Array [

guid string

Identifier.

name string

defaultCurrency Currency (string)

ISO 4217 three-letter currency code.

Possible values: Value must match regular expression ^[A-Z]{3}$

Example: EUR

mailSenderName string

mailSenderAddress email

domain domain

]

property name* any
Example: {"success":true,"tenants":[{"guid":"TE-1234-1234-1234-1234-1234-1234","name":"Tenant A","defaultCurrency":"EUR","mailSenderName":"Tenant A","mailSenderAddress":"[email protected]","domain":"tenant-a.example.org"},{"guid":"TE-4321-4321-4321-4321-4321","name":"Tenant B","defaultCurrency":"EUR","mailSenderName":"Tenant B","mailSenderAddress":"[email protected]","domain":"tenant-b.example.org"}]}

Example (from schema)

{
  "success": true,
  "tenants": [
    {
      "guid": "TE-1234-1234-1234-1234-1234-1234",
      "name": "Tenant A",
      "defaultCurrency": "EUR",
      "mailSenderName": "Tenant A",
      "mailSenderAddress": "[email protected]",
      "domain": "tenant-a.example.org"
    },
    {
      "guid": "TE-4321-4321-4321-4321-4321",
      "name": "Tenant B",
      "defaultCurrency": "EUR",
      "mailSenderName": "Tenant B",
      "mailSenderAddress": "[email protected]",
      "domain": "tenant-b.example.org"
    }
  ]
}

401

Unauthorized, see authentication.

application/json

Schema

Schema

success booleanrequired

true if successful.

errorCode int64required
Error code.
• 1000 - Unauthorized, e.g. invalid credentials
• 1001 - The request is invalid
• 1002 - The value does not comply to the requirements, e.g. pre-defined values
• 1003 - The format is invalid
• 1004 - The value contains invalid characters
• 1005 - Mandatory parameters are missing
• 1006 - Some parameters are not applicable in given request scenario
• 1007 - The provided entity does not exist
• 9999 - Internal system error
Example: 1004
errorMessage stringrequired
Human readable error message.
:::info While the errorMessage field provides useful context for understanding the nature of the error, it's important to note that the content of this message can vary based on specific circumstances. For consistent and reliable error handling in your application, always base your logic on the errorCode field, not the errorMessage. :::
Example: name: nameInvalid characters
property name* any

Example (from schema)

{
  "success": true,
  "errorCode": 1004,
  "errorMessage": "name: nameInvalid characters"
}

1000

Unauthorized (1000)

{
  "success": false,
  "errorCode": 1000,
  "errorMessage": "Unauthorized"
}

422

Unprocessable entity.

application/json

Schema

Schema

success booleanrequired

true if successful.

errorCode int64required
Error code.
• 1000 - Unauthorized, e.g. invalid credentials
• 1001 - The request is invalid
• 1002 - The value does not comply to the requirements, e.g. pre-defined values
• 1003 - The format is invalid
• 1004 - The value contains invalid characters
• 1005 - Mandatory parameters are missing
• 1006 - Some parameters are not applicable in given request scenario
• 1007 - The provided entity does not exist
• 9999 - Internal system error
Example: 1004
errorMessage stringrequired
Human readable error message.
:::info While the errorMessage field provides useful context for understanding the nature of the error, it's important to note that the content of this message can vary based on specific circumstances. For consistent and reliable error handling in your application, always base your logic on the errorCode field, not the errorMessage. :::
Example: name: nameInvalid characters
property name* any

Example (from schema)

{
  "success": true,
  "errorCode": 1004,
  "errorMessage": "name: nameInvalid characters"
}

1001

Unprocessable entity (1001)

{
  "success": false,
  "errorCode": 1001,
  "errorMessage": "Unauthorized"
}

500

Internal server error.

application/json

Schema

Schema

success booleanrequired

true if successful.

errorCode int64required
Error code.
• 1000 - Unauthorized, e.g. invalid credentials
• 1001 - The request is invalid
• 1002 - The value does not comply to the requirements, e.g. pre-defined values
• 1003 - The format is invalid
• 1004 - The value contains invalid characters
• 1005 - Mandatory parameters are missing
• 1006 - Some parameters are not applicable in given request scenario
• 1007 - The provided entity does not exist
• 9999 - Internal system error
Example: 1004
errorMessage stringrequired
Human readable error message.
:::info While the errorMessage field provides useful context for understanding the nature of the error, it's important to note that the content of this message can vary based on specific circumstances. For consistent and reliable error handling in your application, always base your logic on the errorCode field, not the errorMessage. :::
Example: name: nameInvalid characters
property name* any

Example (from schema)

{
  "success": true,
  "errorCode": 1004,
  "errorMessage": "name: nameInvalid characters"
}

1001

Internal server error (9999)

{
  "success": false,
  "errorCode": 9999,
  "errorMessage": "Internal server error"
}

Loading...