ManagedServiceProviderSearchResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/gtm/main/json-schema/gtm-managed-service-provider-search-response-schema.json",
  "title": "ManagedServiceProviderSearchResponse",
  "description": "Search response body for ManagedServiceProvider.",
  "x-generated": "2026-10-20",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/gtm-vertical-datasets-api-v1-api-openapi.yml#/components/schemas/ManagedServiceProviderSearchResponse",
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/ManagedServiceProvider"
      },
      "description": "The primary data of the document"
    },
    "meta": {
      "allOf": [
        {
          "$ref": "#/$defs/ResultMeta"
        }
      ],
      "description": "Non-standard meta information about the document"
    },
    "links": {
      "allOf": [
        {
          "$ref": "#/$defs/Links"
        }
      ],
      "description": "Links related to the primary data"
    }
  },
  "$defs": {
    "Links": {
      "type": "object",
      "properties": {
        "first": {
          "type": "string",
          "format": "uri",
          "description": "A link to the first page of data"
        },
        "last": {
          "type": "string",
          "format": "uri",
          "description": "A link to the last page of data"
        },
        "prev": {
          "type": "string",
          "format": "uri",
          "description": "A link to the previous page of data"
        },
        "next": {
          "type": "string",
          "format": "uri",
          "description": "A link to the next page of data"
        }
      },
      "description": "Helpful links for fetching different pages of data from the current result set."
    },
    "ManagedServiceProvider": {
      "type": "object",
      "required": [
        "id",
        "type",
        "attributes"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "The unique identifier for the resource"
        },
        "type": {
          "type": "string",
          "description": "The type of the resource",
          "default": "ManagedServiceProvider",
          "pattern": "ManagedServiceProvider"
        },
        "attributes": {
          "allOf": [
            {
              "$ref": "#/$defs/ManagedServiceProviderSearchResponseAttributes"
            }
          ],
          "description": "The attributes defining the resource"
        }
      },
      "description": "ManagedServiceProvider record resource."
    },
    "ManagedServiceProviderSearchResponseAttributes": {
      "type": "object",
      "properties": {
        "mspDesignator": {
          "type": "string",
          "description": "MSP or MSSP Flag."
        },
        "ziCompany": {
          "allOf": [
            {
              "$ref": "#/$defs/ZiCompanySearch"
            }
          ],
          "description": "Compact ZiCompany details returned with the record when available."
        }
      },
      "description": "ManagedServiceProvider Search Response Attributes.",
      "x-class-extra-annotation": "@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true)"
    },
    "Page": {
      "type": "object",
      "required": [
        "total",
        "number"
      ],
      "properties": {
        "total": {
          "type": "integer",
          "format": "uint32",
          "description": "The total number of pages within the current result set"
        },
        "number": {
          "type": "integer",
          "format": "uint32",
          "description": "The current page number of the results"
        }
      },
      "description": "Meta information related to the current page and total number of pages"
    },
    "ResultMeta": {
      "type": "object",
      "required": [
        "totalResults",
        "page"
      ],
      "properties": {
        "totalResults": {
          "type": "integer",
          "format": "uint32",
          "description": "The total number of results based on the specified filters"
        },
        "page": {
          "allOf": [
            {
              "$ref": "#/$defs/Page"
            }
          ],
          "description": "Paging information for the current result set"
        }
      },
      "description": "Metadata including paging information and the total number of records in the result set"
    },
    "ZiCompanySearch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "format": "int64",
          "description": "ID."
        },
        "name": {
          "type": "string",
          "description": "name."
        },
        "industry": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "industry."
        },
        "headquartersPhone": {
          "type": "string",
          "description": "headquarters Phone."
        },
        "headquartersStreet": {
          "type": "string",
          "description": "headquarters Street."
        },
        "employees": {
          "type": "integer",
          "format": "int32",
          "description": "employees."
        },
        "revenue": {
          "type": "integer",
          "format": "int32",
          "description": "revenue."
        },
        "city": {
          "type": "string",
          "description": "city."
        },
        "country": {
          "type": "string",
          "description": "country."
        },
        "postalCode": {
          "type": "string",
          "description": "postal Code."
        },
        "state": {
          "type": "string",
          "description": "state."
        }
      },
      "description": "Compact company details returned with Form 5500 records when available."
    }
  }
}