PersonCollectionResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/microsoft-exchange/json-schema/microsoft-exchange-person-collection-response-schema.json",
  "title": "PersonCollectionResponse",
  "description": "Collection of person objects",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/microsoft-exchange-people-api-openapi.yml#/components/schemas/PersonCollectionResponse",
  "type": "object",
  "properties": {
    "@odata.context": {
      "type": "string"
    },
    "@odata.nextLink": {
      "type": "string",
      "format": "uri"
    },
    "value": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Person"
      }
    }
  },
  "$defs": {
    "Location": {
      "type": "object",
      "description": "Location information",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The name of the location"
        },
        "locationType": {
          "type": "string",
          "description": "The type of location"
        },
        "locationUri": {
          "type": "string",
          "description": "URI for the location"
        },
        "address": {
          "$ref": "#/$defs/PhysicalAddress"
        }
      }
    },
    "Person": {
      "type": "object",
      "description": "Represents an aggregation of information about a person from across mail, contacts, and social networks. People can be local contacts, contacts from social networking, the organization's directory, and people from recent communications.",
      "properties": {
        "id": {
          "type": "string",
          "readOnly": true,
          "description": "The person's unique identifier"
        },
        "displayName": {
          "type": "string",
          "description": "The person's display name"
        },
        "givenName": {
          "type": "string",
          "description": "The person's given name"
        },
        "surname": {
          "type": "string",
          "description": "The person's surname"
        },
        "birthday": {
          "type": "string",
          "description": "The person's birthday"
        },
        "personNotes": {
          "type": "string",
          "description": "Free-form notes about this person"
        },
        "isFavorite": {
          "type": "boolean",
          "description": "Whether the user has flagged this person as a favorite"
        },
        "jobTitle": {
          "type": "string",
          "description": "The person's job title"
        },
        "companyName": {
          "type": "string",
          "description": "The name of the person's company"
        },
        "department": {
          "type": "string",
          "description": "The person's department"
        },
        "officeLocation": {
          "type": "string",
          "description": "The location of the person's office"
        },
        "profession": {
          "type": "string",
          "description": "The person's profession"
        },
        "userPrincipalName": {
          "type": "string",
          "description": "The user principal name (UPN) of the person based on RFC 822 in the format alias@domain"
        },
        "imAddress": {
          "type": "string",
          "readOnly": true,
          "description": "The SIP address for VOIP instant messaging"
        },
        "scoredEmailAddresses": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/ScoredEmailAddress"
          },
          "description": "The person's email addresses with relevance scores"
        },
        "phones": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/Phone"
          },
          "description": "The person's phone numbers"
        },
        "postalAddresses": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/Location"
          },
          "description": "The person's addresses"
        },
        "websites": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/Website"
          },
          "description": "The person's websites"
        },
        "personType": {
          "$ref": "#/$defs/PersonType"
        },
        "yomiCompany": {
          "type": "string",
          "description": "Phonetic Japanese company name"
        }
      }
    },
    "PersonType": {
      "type": "object",
      "description": "The type of person",
      "properties": {
        "class": {
          "type": "string",
          "description": "The type of data source such as Person (for directory data) or Group (for unified groups)"
        },
        "subclass": {
          "type": "string",
          "description": "The sub-type such as OrganizationUser, PersonalContact, ExternalContact, or UnifiedGroup"
        }
      }
    },
    "Phone": {
      "type": "object",
      "description": "A phone number",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "home",
            "business",
            "mobile",
            "other",
            "assistant",
            "homeFax",
            "businessFax",
            "otherFax",
            "pager",
            "radio"
          ],
          "description": "The type of phone number"
        },
        "number": {
          "type": "string",
          "description": "The phone number"
        }
      }
    },
    "PhysicalAddress": {
      "type": "object",
      "description": "Physical street address",
      "properties": {
        "street": {
          "type": "string"
        },
        "city": {
          "type": "string"
        },
        "state": {
          "type": "string"
        },
        "countryOrRegion": {
          "type": "string"
        },
        "postalCode": {
          "type": "string"
        }
      }
    },
    "ScoredEmailAddress": {
      "type": "object",
      "description": "An email address with a relevance score",
      "properties": {
        "address": {
          "type": "string",
          "format": "email",
          "description": "The email address"
        },
        "relevanceScore": {
          "type": "number",
          "format": "double",
          "description": "The relevance score of the email address (0.0 to 100.0)"
        },
        "selectionLikelihood": {
          "type": "string",
          "enum": [
            "notSpecified",
            "high"
          ],
          "description": "The likelihood that the email address would be selected"
        }
      }
    },
    "Website": {
      "type": "object",
      "description": "A website",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "other",
            "home",
            "work",
            "blog",
            "profile"
          ],
          "description": "The type of website"
        },
        "address": {
          "type": "string",
          "format": "uri",
          "description": "The URL of the website"
        },
        "displayName": {
          "type": "string",
          "description": "The display name of the website"
        }
      }
    }
  }
}