Chatinbox · Schema

UserFormVM

CompanyCustomer CommunicationCRMWhatsApp Business APIInstagramShared InboxChatbotsConversational AICloud PBXE-CommerceHealthcareTurkey

Properties

Name Type Description
id integer
name stringnull
surname stringnull
username stringnull
password stringnull
campusID integer
projectID integer
groupID integer
iconText stringnull
email stringnull
userMenus arraynull
isActive boolean
userRoleKey stringnull
lang stringnull
phoneViewPermission boolean
chatRole integer
userRoleMenus arraynull
userSkills arraynull
allSkills arraynull
allMenus arraynull
userMenuNames arraynull
allChatRoles arraynull
newWorkGroups arraynull
userWorkGroupRelations arraynull
newInstanceRelations arraynull
userInstanceRelations arraynull
companyID integer
channelManagementPermission boolean
customerMergePermission boolean
pbxExtensionNumber stringnull
pbxExtensionPassword stringnull
isTwoFactorEnabled boolean
isUserIpRestrictionEnabled boolean
phoneNumber stringnull
twoFactorMethod integer
userIpAddresses arraynull
View JSON Schema on GitHub

JSON Schema

chatinbox-net-user-form-vm-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/chatinbox-net/json-schema/chatinbox-net-user-form-vm-schema.json",
  "title": "UserFormVM",
  "x-generated": "2026-11-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/chatinbox-net-openapi.yml#/components/schemas/UserFormVM",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int32"
    },
    "name": {
      "type": [
        "string",
        "null"
      ]
    },
    "surname": {
      "type": [
        "string",
        "null"
      ]
    },
    "username": {
      "type": [
        "string",
        "null"
      ]
    },
    "password": {
      "type": [
        "string",
        "null"
      ]
    },
    "campusID": {
      "type": "integer",
      "format": "int32"
    },
    "projectID": {
      "type": "integer",
      "format": "int32"
    },
    "groupID": {
      "type": "integer",
      "format": "int32"
    },
    "iconText": {
      "type": [
        "string",
        "null"
      ]
    },
    "email": {
      "type": [
        "string",
        "null"
      ]
    },
    "userMenus": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "string"
      }
    },
    "isActive": {
      "type": "boolean"
    },
    "userRoleKey": {
      "type": [
        "string",
        "null"
      ]
    },
    "lang": {
      "type": [
        "string",
        "null"
      ]
    },
    "phoneViewPermission": {
      "type": "boolean"
    },
    "chatRole": {
      "type": "integer",
      "format": "int32"
    },
    "userRoleMenus": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "#/$defs/UserMenuCheckboxVM"
      }
    },
    "userSkills": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "#/$defs/SkillVM"
      }
    },
    "allSkills": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "#/$defs/SkillVM"
      }
    },
    "allMenus": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "#/$defs/UserMenuVM"
      }
    },
    "userMenuNames": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "string"
      }
    },
    "allChatRoles": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "#/$defs/ChatRoleSelect"
      }
    },
    "newWorkGroups": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "string"
      }
    },
    "userWorkGroupRelations": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "#/$defs/UserWorkGroupRelationVM"
      }
    },
    "newInstanceRelations": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "string"
      }
    },
    "userInstanceRelations": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "#/$defs/UserInstanceRelationVM"
      }
    },
    "companyID": {
      "type": "integer",
      "format": "int32"
    },
    "channelManagementPermission": {
      "type": "boolean"
    },
    "customerMergePermission": {
      "type": "boolean"
    },
    "pbxExtensionNumber": {
      "type": [
        "string",
        "null"
      ]
    },
    "pbxExtensionPassword": {
      "type": [
        "string",
        "null"
      ]
    },
    "isTwoFactorEnabled": {
      "type": "boolean"
    },
    "isUserIpRestrictionEnabled": {
      "type": "boolean"
    },
    "phoneNumber": {
      "type": [
        "string",
        "null"
      ]
    },
    "twoFactorMethod": {
      "type": "integer",
      "format": "int32"
    },
    "userIpAddresses": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "#/$defs/UserIpAddressModel"
      }
    }
  },
  "additionalProperties": false,
  "$defs": {
    "ChatRoleSelect": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "format": "int32"
        },
        "name": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "additionalProperties": false
    },
    "SkillVM": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "format": "int32"
        },
        "name": {
          "type": [
            "string",
            "null"
          ]
        },
        "description": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "additionalProperties": false
    },
    "UserInstanceRelationVM": {
      "type": "object",
      "properties": {
        "instanceID": {
          "type": "integer",
          "format": "int32"
        },
        "userID": {
          "type": "integer",
          "format": "int32"
        },
        "instanceName": {
          "type": [
            "string",
            "null"
          ]
        },
        "isDisable": {
          "type": "boolean"
        },
        "chatCount": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    },
    "UserIpAddressModel": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "format": "int32"
        },
        "userID": {
          "type": "integer",
          "format": "int32"
        },
        "ip": {
          "type": [
            "string",
            "null"
          ]
        },
        "description": {
          "type": [
            "string",
            "null"
          ]
        },
        "isActive": {
          "type": "boolean"
        },
        "createDate": {
          "type": "string",
          "format": "date-time"
        },
        "updatedDate": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        }
      },
      "additionalProperties": false
    },
    "UserMenuCheckboxVM": {
      "type": "object",
      "properties": {
        "userMenuID": {
          "type": "integer",
          "format": "int32"
        },
        "name": {
          "type": [
            "string",
            "null"
          ]
        },
        "isActive": {
          "type": "boolean"
        },
        "userRoleID": {
          "type": "integer",
          "format": "int32"
        },
        "userRoleName": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "additionalProperties": false
    },
    "UserMenuVM": {
      "type": "object",
      "properties": {
        "menuKey": {
          "type": [
            "string",
            "null"
          ]
        },
        "urlAction": {
          "type": [
            "string",
            "null"
          ]
        },
        "urlController": {
          "type": [
            "string",
            "null"
          ]
        },
        "fontIcon": {
          "type": [
            "string",
            "null"
          ]
        },
        "sort": {
          "type": "integer",
          "format": "int32"
        },
        "id": {
          "type": "integer",
          "format": "int32"
        },
        "parentID": {
          "type": [
            "integer",
            "null"
          ],
          "format": "int32"
        },
        "isPage": {
          "type": "boolean"
        },
        "menuLabel": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "additionalProperties": false
    },
    "UserWorkGroupRelationVM": {
      "type": "object",
      "properties": {
        "userWorkGroupRelationID": {
          "type": "integer",
          "format": "int32"
        },
        "workGroupName": {
          "type": [
            "string",
            "null"
          ]
        },
        "workGroupID": {
          "type": "integer",
          "format": "int32"
        },
        "userName": {
          "type": [
            "string",
            "null"
          ]
        },
        "userID": {
          "type": "integer",
          "format": "int32"
        },
        "isDisable": {
          "type": "boolean"
        },
        "chatCount": {
          "type": "integer",
          "format": "int32"
        }
      },
      "additionalProperties": false
    }
  }
}

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.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/chatinbox-net-user-form-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.