Merge · Schema

PhoneNumberRequest

# 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
value	stringnull	The phone number.
phone_number_type	object	The type of phone number.
integration_params	objectnull
linked_account_params	objectnull

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/PhoneNumberRequest",
  "title": "PhoneNumberRequest",
  "type": "object",
  "properties": {
    "value": {
      "type": [
        "string",
        "null"
      ],
      "description": "The phone number."
    },
    "phone_number_type": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/PhoneNumberTypeEnum"
        },
        {
          "type": "null"
        }
      ],
      "description": "The type of phone number."
    },
    "integration_params": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "description": "Any type"
      }
    },
    "linked_account_params": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "description": "Any type"
      }
    }
  },
  "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."
}