Get Companies
Get All Companies
Query Parameters
- includeDeletedCompanies boolean
If true, companies marked for deletion are included in the response
- 200
- 404
Success
- application/json
- Schema
- Example (from schema)
Schema
companies object[]
id int32Company Id
name stringCompany name
GUID stringGUID of the company
alias stringThe company domain or NetBIOS name
isReseller booleanEnable reseller mode. A reseller is a user or user groups who can operate multiple tenant environments. The service provider can assign one or more resellers as the tenant operator for a company. The reseller can switch to any of their assigned tenant environment and operate on the company as a tenant user. Once enabled, the reseller mode cannot be disabled.
primaryContacts object[]
id int32name stringassociatedEntitiesCount int32Gives the number of entities associated with the company
status stringPossible values: [
UNKNOWN
,ACTIVE
,DEACTIVATED
,DELETED
]Gives the company status
tags object
id int32name stringvalue stringcommcell object
name stringName of the commcell the entity belongs to.
displayName stringDisplay name of the commcell the entity belongs to.
operators object[]
List of operators configured for the company
fullName stringFull name of the operator
userGroup object
id int32name stringuser object
id int32name stringrole object
id int32name string- companyCount int32
Total number of companies
{
"companies": [
{
"id": 0,
"name": "string",
"GUID": "string",
"alias": "string",
"isReseller": true,
"primaryContacts": [
{
"id": 0,
"name": "string"
}
],
"associatedEntitiesCount": 0,
"status": "UNKNOWN",
"tags": {
"id": 0,
"name": "string",
"value": "string"
},
"commcell": {
"name": "string",
"displayName": "string"
},
"operators": [
{
"fullName": "string",
"userGroup": {
"id": 0,
"name": "string"
},
"user": {
"id": 0,
"name": "string"
},
"role": {
"id": 0,
"name": "string"
}
}
]
}
],
"companyCount": 0
}
Requested Details not found