Merge · Schema

PhoneNumber

# The PhoneNumber Object ### Description The `PhoneNumber` object is used to represent a candidate's phone number. ### Usage Example Fetch from the `GET Candidate` endpoint and view their phone numbers.

IntegrationsPlatformUnified APIAgent HandlerLLM Gateway

Properties

Name	Type	Description
created_at	string	The datetime that this object was created by Merge.
modified_at	string	The datetime that this object was modified by Merge.
value	stringnull	The phone number.
phone_number_type	object	The type of phone number.
remote_was_deleted	boolean	Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited cove

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PhoneNumber",
  "title": "PhoneNumber",
  "type": "object",
  "properties": {
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "The datetime that this object was created by Merge."
    },
    "modified_at": {
      "type": "string",
      "format": "date-time",
      "description": "The datetime that this object was modified by Merge."
    },
    "value": {
      "type": [
        "string",
        "null"
      ],
      "description": "The phone number."
    },
    "phone_number_type": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/PhoneNumberTypeEnum"
        },
        {
          "type": "null"
        }
      ],
      "description": "The type of phone number."
    },
    "remote_was_deleted": {
      "type": "boolean",
      "description": "Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/)."
    }
  },
  "description": "# The PhoneNumber Object\n### Description\nThe `PhoneNumber` object is used to represent a candidate's phone number.\n### Usage Example\nFetch from the `GET Candidate` endpoint and view their phone numbers."
}