PersonPage

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/1password/json-schema/1password-person-page-schema.json",
  "title": "PersonPage",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/1password-people-api-openapi.yml#/components/schemas/PersonPage",
  "type": "object",
  "properties": {
    "next": {
      "type": "string",
      "description": "The URL of the next page of results. Absent when there are no more results."
    },
    "results": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/Person"
      },
      "description": "The page of results."
    }
  },
  "additionalProperties": false,
  "$defs": {
    "AddressDetails": {
      "type": "object",
      "properties": {
        "streetAddress1": {
          "type": [
            "string",
            "null"
          ]
        },
        "streetAddress2": {
          "type": [
            "string",
            "null"
          ]
        },
        "city": {
          "type": [
            "string",
            "null"
          ]
        },
        "stateOrProvince": {
          "type": [
            "string",
            "null"
          ]
        },
        "zipOrPostalCode": {
          "type": [
            "string",
            "null"
          ]
        },
        "countryCode": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "additionalProperties": false
    },
    "Person": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The person's unique ID"
        },
        "employeeType": {
          "type": "string",
          "description": "A free-text employee type (e.g. full-time, part-time). Distinct from personType."
        },
        "personType": {
          "allOf": [
            {
              "$ref": "#/$defs/PersonType"
            }
          ],
          "description": "Classifies the person: Employee, Contractor, ServiceAccount or External. Distinct from the free-text employeeType."
        },
        "aliases": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Email addresses linked to this person"
        },
        "userName": {
          "type": "string",
          "description": "The user's logon name (from integrations)"
        },
        "firstName": {
          "type": "string",
          "description": "First name"
        },
        "lastName": {
          "type": "string",
          "description": "Last name"
        },
        "email": {
          "type": "string",
          "description": "Primary email address"
        },
        "jobTitle": {
          "type": "string",
          "description": "Job title"
        },
        "locationId": {
          "type": "string",
          "description": "The location's unique identifier (derived from location)"
        },
        "location": {
          "type": "string",
          "description": "A description of the user's location. A matching location is found or created when set."
        },
        "locationCountryCode": {
          "type": "string",
          "description": "The user's country (derived from location)"
        },
        "locationTimezone": {
          "type": "string",
          "description": "The IANA time zone name of the user's location, e.g. `America/New_York` (derived from location)"
        },
        "costCenterId": {
          "type": "string",
          "description": "The ID of the cost center (derived from costCenter)"
        },
        "costCenter": {
          "type": "string",
          "description": "Cost center. A matching cost center is found or created when set."
        },
        "organizationalUnit": {
          "type": "string",
          "description": "The organizational unit, sourced from directory integrations (e.g. Google Workspace, Active Directory)."
        },
        "loginName": {
          "type": "string",
          "description": "The person's login name on the local domain. Used in conjunction with the SaaS Manager Browser Extension Helper to determine the identity of the logged in user."
        },
        "timezone": {
          "type": "string",
          "description": "The person's IANA time zone name, e.g. `America/New_York`"
        },
        "employeeId": {
          "type": "string",
          "description": "Employee ID"
        },
        "phoneNumber": {
          "type": "string",
          "description": "Phone number"
        },
        "status": {
          "allOf": [
            {
              "$ref": "#/$defs/PersonStatus"
            }
          ],
          "description": "Status (new, terminated, etc)"
        },
        "personalAddress": {
          "allOf": [
            {
              "$ref": "#/$defs/AddressDetails"
            }
          ],
          "description": "Home address"
        },
        "lineManager": {
          "allOf": [
            {
              "$ref": "#/$defs/PersonInfo"
            }
          ],
          "description": "The person's line manager. On input, set it by the line manager's id or email (other fields are ignored); alternatively use lineManagerId or lineManagerEmail. These three forms are mutually exclusive."
        },
        "teams": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/Team"
          },
          "description": "The teams the person belongs to. When creating or replacing, supply teams by ID, or by name (a team is created if the name is not found); mutually exclusive with teamIds."
        },
        "customFields": {
          "type": "object",
          "additionalProperties": {
            "$ref": "#/$defs/PersonCustomFieldValue"
          },
          "description": "Custom field values"
        },
        "startDate": {
          "type": "string",
          "description": "(ISO format) Date that the person joined the organization. Passing null clears the date.",
          "format": "date-time"
        },
        "leavingDate": {
          "type": "string",
          "description": "(ISO format) Date that the person left the organization or is due to lave. Passing null clears the date.",
          "format": "date-time"
        },
        "createdBy": {
          "allOf": [
            {
              "$ref": "#/$defs/UserInfo"
            }
          ],
          "description": "The user that created the person record"
        },
        "createdDtm": {
          "type": "string",
          "description": "The timestamp for when the person record was created",
          "format": "date-time"
        },
        "lastModifiedBy": {
          "allOf": [
            {
              "$ref": "#/$defs/UserInfo"
            }
          ],
          "description": "The user that last modified the person record"
        },
        "lastModifiedDtm": {
          "type": "string",
          "description": "The timestamp for when the person record was last modified",
          "format": "date-time"
        }
      },
      "additionalProperties": false,
      "description": "A SaaS Manager person"
    },
    "PersonCustomFieldValue": {
      "type": "object",
      "properties": {
        "numberValue": {
          "type": [
            "number",
            "null"
          ],
          "format": "double"
        },
        "optionValue": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "string"
          }
        },
        "textValue": {
          "type": [
            "string",
            "null"
          ]
        },
        "dateValue": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "linkValue": {
          "allOf": [
            {
              "$ref": "#/$defs/PersonLinkValue"
            }
          ]
        },
        "personValue": {
          "allOf": [
            {
              "$ref": "#/$defs/PersonPersonValue"
            }
          ]
        }
      },
      "additionalProperties": false
    },
    "PersonInfo": {
      "type": "object",
      "properties": {
        "id": {
          "type": [
            "string",
            "null"
          ]
        },
        "personType": {
          "allOf": [
            {
              "$ref": "#/$defs/PersonValueType"
            }
          ]
        },
        "name": {
          "type": [
            "string",
            "null"
          ]
        },
        "email": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "additionalProperties": false
    },
    "PersonLinkValue": {
      "type": "object",
      "properties": {
        "href": {
          "type": [
            "string",
            "null"
          ]
        },
        "description": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "additionalProperties": false
    },
    "PersonPersonValue": {
      "type": "object",
      "properties": {
        "id": {
          "type": [
            "string",
            "null"
          ]
        },
        "personType": {
          "allOf": [
            {
              "$ref": "#/$defs/PersonValueType"
            }
          ]
        },
        "name": {
          "type": [
            "string",
            "null"
          ]
        },
        "email": {
          "type": [
            "string",
            "null"
          ]
        },
        "externalId": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "additionalProperties": false
    },
    "PersonStatus": {
      "enum": [
        "New",
        "Terminated",
        "Active",
        "Unknown"
      ],
      "type": "string"
    },
    "PersonType": {
      "enum": [
        "Employee",
        "Contractor",
        "ServiceAccount",
        "External"
      ],
      "type": "string"
    },
    "PersonValueType": {
      "enum": [
        "Contact",
        "User"
      ],
      "type": "string"
    },
    "Team": {
      "type": "object",
      "properties": {
        "id": {
          "type": [
            "string",
            "null"
          ],
          "description": "The team's unique ID. Omit when creating a team by name."
        },
        "name": {
          "type": [
            "string",
            "null"
          ],
          "description": "The team's name"
        }
      },
      "additionalProperties": false,
      "description": "A team that a person can belong to"
    },
    "UserInfo": {
      "type": "object",
      "properties": {
        "userId": {
          "type": [
            "string",
            "null"
          ]
        },
        "name": {
          "type": [
            "string",
            "null"
          ]
        },
        "email": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "additionalProperties": false
    }
  }
}