tenant-controller
Get Tenants (getTenants)
Returns a page of tenants registered in the platform. You can specify parameters to filter the results. The result is wrapped with PageData object that allows you to iterate over result set using pagination. See response schema for more details.
Available for users with 'SYS_ADMIN' authority.
get/api/tenants
Query parameters
tenantIdsstring[] required
A list of tenant ids, separated by comma ','
pageSizeinteger required
Maximum amount of entities in a one page
pageinteger required
Sequence number of page starting from 0
textSearchstring
The case insensitive 'substring' filter based on the tenant name.
sortProperty'createdTime' | 'title' | 'email' | 'country' | 'state' | 'city' | 'address' | 'address2' | 'zip' | 'phone' | 'email'
Property of entity to sort by
sortOrder'ASC' | 'DESC'
Sort order. ASC (ASCENDING) or DESC (DESCENDING)
Response
OK
Example response
{
"data": [
{
"id": {
"id": "784f394c-42b6-435a-983c-b7beff2784f9",
"entityType": "TENANT"
},
"createdTime": 1609459200000,
"country": "US",
"state": "NY",
"city": "New York",
"phone": "+1(415)777-7777",
"email": "example@company.com",
"title": "Company A",
"region": "North America",
"tenantProfileId": {
"id": "784f394c-42b6-435a-983c-b7beff2784f9",
"entityType": "TENANT_PROFILE"
},
"name": "Company A",
"additionalInfo": {}
}
]
}