Chatinbox · Schema
IdVM
CompanyCustomer CommunicationCRMWhatsApp Business APIInstagramShared InboxChatbotsConversational AICloud PBXE-CommerceHealthcareTurkey
Properties
| Name | Type | Description |
|---|---|---|
| id | integer | |
| phonePermission | boolean | |
| obj | objectnull | |
| companyInstances | arraynull |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/chatinbox-net/json-schema/chatinbox-net-id-vm-schema.json",
"title": "IdVM",
"x-generated": "2026-11-10",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/chatinbox-net-account-api-openapi.yml#/components/schemas/IdVM",
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"phonePermission": {
"type": "boolean"
},
"obj": {
"type": [
"object",
"null"
],
"additionalProperties": false
},
"companyInstances": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/$defs/CompanyInstance"
}
}
},
"additionalProperties": false,
"$defs": {
"AuthorizedArea": {
"type": "object",
"properties": {
"name": {
"type": [
"string",
"null"
]
},
"authorizedAreaType": {
"$ref": "#/$defs/AuthorizedAreaType"
},
"authorizedAreaLicenseTypeRelations": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/$defs/AuthorizedAreaLicenseTypeRelation"
}
},
"id": {
"type": "integer",
"format": "int32"
},
"createDate": {
"type": "string",
"format": "date-time"
},
"updatedDate": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdBy": {
"type": [
"string",
"null"
]
},
"updatedBy": {
"type": [
"string",
"null"
]
},
"dataStatus": {
"$ref": "#/$defs/DataStatus"
}
},
"additionalProperties": false
},
"AuthorizedAreaLicenseTypeRelation": {
"type": "object",
"properties": {
"authorizedAreaID": {
"type": "integer",
"format": "int32"
},
"licenseTypeID": {
"type": "integer",
"format": "int32"
},
"authorizedArea": {
"$ref": "#/$defs/AuthorizedArea"
},
"licenseType": {
"$ref": "#/$defs/LicenseType"
},
"id": {
"type": "integer",
"format": "int32"
},
"createDate": {
"type": "string",
"format": "date-time"
},
"updatedDate": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdBy": {
"type": [
"string",
"null"
]
},
"updatedBy": {
"type": [
"string",
"null"
]
},
"dataStatus": {
"$ref": "#/$defs/DataStatus"
}
},
"additionalProperties": false
},
"AuthorizedAreaType": {
"enum": [
1,
2
],
"type": "integer",
"format": "int32"
},
"ChatProvider": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"maxLength": 500,
"minLength": 0,
"type": [
"string",
"null"
]
},
"enumValue": {
"type": "integer",
"format": "int32"
},
"companyInstances": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/$defs/CompanyInstance"
}
},
"id": {
"type": "integer",
"format": "int32"
},
"createDate": {
"type": "string",
"format": "date-time"
},
"updatedDate": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdBy": {
"type": [
"string",
"null"
]
},
"updatedBy": {
"type": [
"string",
"null"
]
},
"dataStatus": {
"$ref": "#/$defs/DataStatus"
}
},
"additionalProperties": false
},
"Company": {
"required": [
"code",
"databaseName",
"name"
],
"type": "object",
"properties": {
"parentID": {
"type": "integer",
"format": "int32"
},
"code": {
"maxLength": 250,
"minLength": 0,
"type": [
"string",
"null"
]
},
"name": {
"maxLength": 250,
"minLength": 0,
"type": [
"string",
"null"
]
},
"logoUrl": {
"type": [
"string",
"null"
]
},
"pbxServerID": {
"type": [
"integer",
"null"
],
"format": "int32"
},
"databaseServerID": {
"type": "integer",
"format": "int32"
},
"wssServerID": {
"type": [
"integer",
"null"
],
"format": "int32"
},
"chatServerID": {
"type": [
"integer",
"null"
],
"format": "int32"
},
"apiServerID": {
"type": [
"integer",
"null"
],
"format": "int32"
},
"databaseName": {
"maxLength": 250,
"minLength": 0,
"type": [
"string",
"null"
]
},
"mainCompany": {
"type": "boolean"
},
"companyInstallType": {
"$ref": "#/$defs/CompanyInstallTypeEnum"
},
"recordApiUrl": {
"type": [
"string",
"null"
]
},
"recordPath": {
"type": [
"string",
"null"
]
},
"chatServer": {
"$ref": "#/$defs/Server"
},
"tradeName": {
"type": [
"string",
"null"
]
},
"adress": {
"type": [
"string",
"null"
]
},
"taxAdministration": {
"type": [
"string",
"null"
]
},
"taxNumber": {
"maxLength": 20,
"minLength": 0,
"type": [
"string",
"null"
]
},
"mersisNo": {
"maxLength": 30,
"minLength": 0,
"type": [
"string",
"null"
]
},
"relatedPerson": {
"maxLength": 100,
"minLength": 0,
"type": [
"string",
"null"
]
},
"relatedEmail": {
"maxLength": 100,
"minLength": 0,
"type": [
"string",
"null"
]
},
"releatedPhoneNumber": {
"maxLength": 16,
"minLength": 0,
"type": [
"string",
"null"
]
},
"userLicenseCount": {
"type": [
"integer",
"null"
],
"format": "int32"
},
"instanceLicenseCount": {
"type": [
"integer",
"null"
],
"format": "int32"
},
"licenseExpireDate": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"licenseProgressType": {
"type": [
"integer",
"null"
],
"format": "int32"
},
"apiKey": {
"type": [
"string",
"null"
]
},
"apiStatus": {
"type": [
"boolean",
"null"
]
},
"apiConfiguration": {
"type": [
"string",
"null"
]
},
"licenseTypeID": {
"type": [
"integer",
"null"
],
"format": "int32"
},
"isShowShortcutMenu": {
"type": "boolean"
},
"messageLimitPerMinute": {
"type": [
"integer",
"null"
],
"format": "int32"
},
"messageLimitPerDaily": {
"type": [
"integer",
"null"
],
"format": "int32"
},
"gmt": {
"type": [
"integer",
"null"
],
"format": "int32"
},
"invektoCompanyCode": {
"type": [
"string",
"null"
]
},
"licenseRenewalPeriod": {
"type": [
"integer",
"null"
],
"format": "int32"
},
"licenseFeature": {
"type": [
"string",
"null"
]
},
"whiteLabelCompanyID": {
"type": [
"integer",
"null"
],
"format": "int32"
},
"whiteLabelCompany": {
"$ref": "#/$defs/WhiteLabelCompany"
},
"databaseServer": {
"$ref": "#/$defs/Server"
},
"companyInstances": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/$defs/CompanyInstance"
}
},
"companyIntegrationParameters": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/$defs/CompanyIntegrationParameter"
}
},
"companyIntegrations": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/$defs/CompanyIntegration"
}
},
"companyIpAddresses": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/$defs/CompanyIpAddress"
}
},
"companyInstanceRequests": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/$defs/CompanyInstanceRequest"
}
},
"licenseType": {
"$ref": "#/$defs/LicenseType"
},
"licenseHistories": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/$defs/LicenseHistory"
}
},
"id": {
"type": "integer",
"format": "int32"
},
"createDate": {
"type": "string",
"format": "date-time"
},
"updatedDate": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdBy": {
"type": [
"string",
"null"
]
},
"updatedBy": {
"type": [
"string",
"null"
]
},
"dataStatus": {
"$ref": "#/$defs/DataStatus"
}
},
"additionalProperties": false
},
"CompanyInstallTypeEnum": {
"enum": [
1,
2,
3
],
"type": "integer",
"format": "int32"
},
"CompanyInstance": {
"type": "object",
"properties": {
"companyID": {
"type": "integer",
"format": "int32"
},
"name": {
"maxLength": 500,
"minLength": 0,
"type": [
"string",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"phoneNumber": {
"maxLength": 15,
"minLength": 0,
"type": [
"string",
"null"
]
},
"chatProviderID": {
"type": "integer",
"format": "int32"
},
"providerInstanceID": {
"maxLength": 50,
"minLength": 0,
"type": [
"string",
"null"
]
},
"token": {
"maxLength": 500,
"minLength": 0,
"type": [
"string",
"null"
]
},
"apiUrl": {
"maxLength": 500,
"minLength": 0,
"type": [
"string",
"null"
]
},
"apiCommunicationURL": {
"maxLength": 500,
"minLength": 0,
"type": [
"string",
"null"
]
},
"lastActiveTime": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"expireDate": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"instanceStatus": {
"type": "boolean"
},
"instanceStatusText": {
"maxLength": 500,
"minLength": 0,
"type": [
"string",
"null"
]
},
"instanceQRImage": {
"type": [
"string",
"null"
]
},
"instanceSessionInfo": {
"type": [
"string",
"null"
]
},
"instanceApiPort": {
"type": [
"integer",
"null"
],
"format": "int32"
},
"gmt": {
"type": [
"integer",
"null"
],
"format": "int32"
},
"instanceType": {
"$ref": "#/$defs/InstanceType"
},
"accountGuid": {
"type": [
"string",
"null"
]
},
"username": {
"type": [
"string",
"null"
]
},
"password": {
"type": [
"string",
"null"
]
},
"chatProvider": {
"$ref": "#/$defs/ChatProvider"
},
"company": {
"$ref": "#/$defs/Company"
},
"pageID": {
"type": [
"string",
"null"
]
},
"outOfControl": {
"type": [
"boolean",
"null"
]
},
"id": {
"type": "integer",
"format": "int32"
},
"createDate": {
"type": "string",
"format": "date-time"
},
"updatedDate": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdBy": {
"type": [
"string",
"null"
]
},
"updatedBy": {
"type": [
"string",
"null"
]
},
"dataStatus": {
"$ref": "#/$defs/DataStatus"
}
},
"additionalProperties": false
},
"CompanyInstanceRequest": {
"type": "object",
"properties": {
"companyID": {
"type": "integer",
"format": "int32"
},
"instanceType": {
"$ref": "#/$defs/InstanceType"
},
"displayName": {
"type": [
"string",
"null"
]
},
"phoneNumber": {
"type": [
"string",
"null"
]
},
"accountName": {
"type": [
"string",
"null"
]
},
"password": {
"type": [
"string",
"null"
]
},
"instanceProgressType": {
"$ref": "#/$defs/InstanceProgressType"
},
"requestUserID": {
"type": "integer",
"format": "int32"
},
"company": {
"$ref": "#/$defs/Company"
},
"id": {
"type": "integer",
"format": "int32"
},
"createDate": {
"type": "string",
"format": "date-time"
},
"updatedDate": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdBy": {
"type": [
"string",
"null"
]
},
"updatedBy": {
"type": [
"string",
"null"
]
},
"dataStatus": {
"$ref": "#/$defs/DataStatus"
}
},
"additionalProperties": false
},
"CompanyIntegration": {
"type": "object",
"properties": {
"companyID": {
"type": "integer",
"format": "int32"
},
"integrationCompanyID": {
"type": "integer",
"format": "int32"
},
"company": {
"$ref": "#/$defs/Company"
},
"integrationCompany": {
"$ref": "#/$defs/IntegrationCompany"
},
"id": {
"type": "integer",
"format": "int32"
},
"createDate": {
"type": "string",
"format": "date-time"
},
"updatedDate": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdBy": {
"type": [
"string",
"null"
]
},
"updatedBy": {
"type": [
"string",
"null"
]
},
"dataStatus": {
"$ref": "#/$defs/DataStatus"
}
},
"additionalProperties": false
},
"CompanyIntegrationParameter": {
"type": "object",
"properties": {
"companyID": {
"type": "integer",
"format": "int32"
},
"integrationCompanyID": {
"type": "integer",
"format": "int32"
},
"parametersLabelID": {
"type": [
"integer",
"null"
],
"format": "int32"
},
"value": {
"type": [
"string",
"null"
]
},
"companyUserID": {
"type": "integer",
"format": "int32"
},
"companyItemID": {
"type": "integer",
"format": "int32"
},
"company": {
"$ref": "#/$defs/Company"
},
"integrationCompany": {
"$ref": "#/$defs/IntegrationCompany"
},
"id": {
"type": "integer",
"format": "int32"
},
"createDate": {
"type": "string",
"format": "date-time"
},
"updatedDate": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdBy": {
"type": [
"string",
"null"
]
},
"updatedBy": {
"type": [
"string",
"null"
]
},
"dataStatus": {
"$ref": "#/$defs/DataStatus"
}
},
"additionalProperties": false
},
"CompanyIpAddress": {
"type": "object",
"properties": {
"companyID": {
"type": "integer",
"format": "int32"
},
"ip": {
"maxLength": 50,
"minLength": 0,
"type": [
"string",
"null"
]
},
"url": {
"maxLength": 150,
"minLength": 0,
"type": [
"string",
"null"
]
},
"company": {
"$ref": "#/$defs/Company"
},
"id": {
"type": "integer",
"format": "int32"
},
"createDate": {
"type": "string",
"format": "date-time"
},
"updatedDate": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdBy": {
"type": [
"string",
"null"
]
},
"updatedBy": {
"type": [
"string",
"null"
]
},
"dataStatus": {
"$ref": "#/$defs/DataStatus"
}
},
"additionalProperties": false
},
"DataStatus": {
"enum": [
0,
1,
2
],
"type": "integer",
"format": "int32"
},
"InstanceProgressType": {
"enum": [
1,
2,
3,
4,
5
],
"type": "integer",
"format": "int32"
},
"InstanceType": {
"enum": [
1,
2,
3,
4,
5,
6
],
"type": "integer",
"format": "int32"
},
"IntegrationCompany": {
"type": "object",
"properties": {
"name": {
"maxLength": 20,
"minLength": 0,
"type": [
"string",
"null"
]
},
"label": {
"type": [
"string",
"null"
]
},
"logoUrl": {
"type": [
"string",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"must": {
"type": [
"integer",
"null"
],
"format": "int32"
},
"companyIntegrationParameters": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/$defs/CompanyIntegrationParameter"
}
},
"companyIntegrations": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/$defs/CompanyIntegration"
}
},
"integrationEvents": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/$defs/IntegrationEvent"
}
},
"parametersLabels": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/$defs/ParametersLabel"
}
},
"id": {
"type": "integer",
"format": "int32"
},
"createDate": {
"type": "string",
"format": "date-time"
},
"updatedDate": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdBy": {
"type": [
"string",
"null"
]
},
"updatedBy": {
"type": [
"string",
"null"
]
},
"dataStatus": {
"$ref": "#/$defs/DataStatus"
}
},
"additionalProperties": false
},
"IntegrationEvent": {
"type": "object",
"properties": {
"name": {
"maxLength": 100,
"minLength": 0,
"type": [
"string",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"eventKey": {
"maxLength": 100,
"minLength": 0,
"type": [
"string",
"null"
]
},
"integrationCompanyID": {
"type": [
"integer",
"null"
],
"format": "int32"
},
"inbounEvent": {
"type": [
"boolean",
"null"
]
},
"integrationCompany": {
"$ref": "#/$defs/IntegrationCompany"
},
"id": {
"type": "integer",
"format": "int32"
},
"createDate": {
"type": "string",
"format": "date-time"
},
"updatedDate": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdBy": {
"type": [
"string",
"null"
]
},
"updatedBy": {
"type": [
"string",
"null"
]
},
"dataStatus": {
"$ref": "#/$defs/DataStatus"
}
},
"additionalProperties": false
},
"LicenseChangeType": {
"enum": [
1,
2,
3
],
"type": "integer",
"format": "int32"
},
"LicenseHistory": {
"type": "object",
"properties": {
"companyID": {
"type": "integer",
"format": "int32"
},
"licenseTypeID": {
"type": "integer",
"format": "int32"
},
"licenseHistoryType": {
"$ref": "#/$defs/LicenseHistoryType"
},
"model": {
"type": [
"string",
"null"
]
},
"licenseStart": {
"type": "string",
"format": "date-time"
},
"licenseEnd": {
"type": "string",
"format": "date-time"
},
"licenseChangeType": {
"$ref": "#/$defs/LicenseChangeType"
},
"uniqueCode": {
"type": [
"string",
"null"
]
},
"isPaymentReceived": {
"type": "boolean"
},
"company": {
"$ref": "#/$defs/Company"
},
"licenseType": {
"$ref": "#/$defs/LicenseType"
},
"id": {
"type": "integer",
"format": "int32"
},
"createDate": {
"type": "string",
"format": "date-time"
},
"updatedDate": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdBy": {
"type": [
"string",
"null"
]
},
"updatedBy": {
"type": [
"string",
"null"
]
},
"dataStatus": {
"$ref": "#/$defs/DataStatus"
}
},
"additionalProperties": false
},
"LicenseHistoryType": {
"enum": [
1,
2,
3
],
"type": "integer",
"format": "int32"
},
"LicenseType": {
"type": "object",
"properties": {
"name": {
"type": [
"string",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"whiteLabelCompanyID": {
"type": "integer",
"format": "int32"
},
"price": {
"type": "number",
"format": "double"
},
"returnUrl": {
"type": [
"string",
"null"
]
},
"isShopifyBaseLicense": {
"type": "boolean"
},
"whiteLabelCompany": {
"$ref": "#/$defs/WhiteLabelCompany"
},
"authorizedAreaLicenseTypeRelations": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/$defs/AuthorizedAreaLicenseTypeRelation"
}
},
"companies": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/$defs/Company"
}
},
"licenseHistories": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/$defs/LicenseHistory"
}
},
"id": {
"type": "integer",
"format": "int32"
},
"createDate": {
"type": "string",
"format": "date-time"
},
"updatedDate": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdBy": {
"type": [
"string",
"null"
]
},
"updatedBy": {
"type": [
"string",
"null"
]
},
"dataStatus": {
"$ref": "#/$defs/DataStatus"
}
},
"additionalProperties": false
},
"ParametersLabel": {
"type": "object",
"properties": {
"integrationID": {
"type": [
"integer",
"null"
],
"format": "int32"
},
"parameterSource": {
"maxLength": 250,
"minLength": 0,
"type": [
"string",
"null"
]
},
"label": {
"maxLength": 250,
"minLength": 0,
"type": [
"string",
"null"
]
},
"parameterType": {
"type": [
"integer",
"null"
],
"format": "int32"
},
"isVisibility": {
"type": [
"boolean",
"null"
]
},
"isReadOnly": {
"type": [
"boolean",
"null"
]
},
"must": {
"type": "integer",
"format": "int32"
},
"integration": {
"$ref": "#/$defs/IntegrationCompany"
},
"id": {
"type": "integer",
"format": "int32"
},
"createDate": {
"type": "string",
"format": "date-time"
},
"updatedDate": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"createdBy": {
"type": [
"string",
"null"
]
},
"updatedBy": {
"type": [
"string",
"null"
]
},
"dataStatus": {
"$ref": "#/$defs/DataStatus"
}
},
"additionalProperties": false
},
"Server": {
"required": [
"name",
"serverIp"
],
"type": "object",
"properties": {
"name": {
"maxLength": 50,
"minLength": 0,
"type": [
"string",
"null"
]
},
"serverIp": {
"maxLength": 50,
"minLength": 0,
"type": [
"string",
"null"
]
},
"serverUrl": {
"maxLength": 250,
"minLength": 0,
"type": [
"string",
"null"
]
},
"serverInstance": {
"maxLength": 50,
"minLength": 0,
"type": [
"string",
"null"
]
},
"serverUser": {
"maxLength": 50,
"minLength": 0,
"type": [
"string",
"null"
]
},
"serverPassword": {
"maxLength": 50,
"minLength": 0,
"type": [
"string",
"null"
]
},
"webHookPort": {
"type": [
"integer",
"null"
],
"format": "int32"
},
"signalRPort": {
"type": [
"integer",
"null"
],
"format": "int32"
},
"serverType": {
"$ref": "#/$defs/ServerType"
},
"port": {
"type": [
"integer",
"null"
],
"format": "int32"
},
"companyChatServers": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/$defs/Company"
}
},
"companyDatabaseServers": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/$d
# --- truncated at 32 KB (35 KB total) ---
# Full source: https://artifacts.apis.io/chatinbox-net/json-schema/chatinbox-net-id-vm-schema.json
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/chatinbox-net-id-vm"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.