Mews · Schema

CompanyResult

HospitalityHotelsPMSProperty Management

Properties

Name Type Description
Companies array The company profiles of the enterprise.
Cursor string Unique identifier of the last and hence oldest company item returned. This can be used in [Limitation](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/#limitation) in a subsequent
View JSON Schema on GitHub

JSON Schema

mews-companyresult-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CompanyResult",
  "title": "CompanyResult",
  "required": [
    "Companies"
  ],
  "type": "object",
  "properties": {
    "Companies": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Company"
      },
      "description": "The company profiles of the enterprise."
    },
    "Cursor": {
      "type": "string",
      "description": "Unique identifier of the last and hence oldest company item returned. This can be used in [Limitation](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/#limitation) in a subsequent request to fetch the next batch of older companies. If [Limitation](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/#limitation) is specified in the request message, then Cursor will always be included in the response message; this is true even when using Extents set to false so that no actual data is returned.",
      "format": "uuid",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "x-schema-id": "CompanyResult"
}