Get Tenant Count
Query for tenants using a list of parameters and retrieves the count.
Method
GET /tenant/count
Parameters
Query Parameters
| Name | Description |
|---|---|
| id | Filter by the id of the tenant. |
| name | Filter by the name of the tenant. |
| nameLike | Filter by the name that the parameter is a substring of. |
| userMember | Select only tenants where the given user is a member of. |
| groupMember | Select only tenants where the given group is a member of. |
| includingGroupsOfUser | Select only tenants where the user or one of his groups is a member of. Can only be used in combination with the userMember parameter. Value may only be true, as false is the default behavior. |
Result
A JSON object that contains the count as the only property.
| Name | Value | Description |
|---|---|---|
| count | Number | The number of matching tenants. |
Response Codes
| Code | Media type | Description |
|---|---|---|
| 200 | application/json | Request successful. |
| 400 | application/json | Returned if some of the query parameters are invalid. See the Introduction for the error response format. |
Example
Request
GET /tenant/count?name=tenantOne
Response
Status 200.
{"count": 1}