Merge · Schema

Candidate

A candidate in the recruiting pipeline from a connected ATS integration.

IntegrationsPlatformUnified APIAgent HandlerLLM Gateway

Properties

Name	Type	Description
id	string	Unique Merge identifier.
remote_id	string	Third-party ID.
first_name	string	First name.
last_name	string	Last name.
company	string	Current or most recent company.
title	string	Current or most recent title.
is_private	boolean	Whether the candidate is private.
can_email	boolean	Whether the candidate can be emailed.
email_addresses	array
phone_numbers	array
tags	array
applications	array
attachments	array
remote_was_deleted	boolean
created_at	string
modified_at	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/merge/refs/heads/main/json-schema/ats-api-candidate-schema.json",
  "title": "Candidate",
  "description": "A candidate in the recruiting pipeline from a connected ATS integration.",
  "type": "object",
  "properties": {
    "id": { "type": "string", "format": "uuid", "description": "Unique Merge identifier." },
    "remote_id": { "type": "string", "description": "Third-party ID." },
    "first_name": { "type": "string", "description": "First name." },
    "last_name": { "type": "string", "description": "Last name." },
    "company": { "type": "string", "description": "Current or most recent company." },
    "title": { "type": "string", "description": "Current or most recent title." },
    "is_private": { "type": "boolean", "description": "Whether the candidate is private." },
    "can_email": { "type": "boolean", "description": "Whether the candidate can be emailed." },
    "email_addresses": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "value": { "type": "string", "format": "email" },
          "email_address_type": { "type": "string", "enum": ["PERSONAL", "WORK", "OTHER"] }
        }
      }
    },
    "phone_numbers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "value": { "type": "string" },
          "phone_number_type": { "type": "string", "enum": ["HOME", "WORK", "MOBILE", "SKYPE", "OTHER"] }
        }
      }
    },
    "tags": { "type": "array", "items": { "type": "string" } },
    "applications": { "type": "array", "items": { "type": "string", "format": "uuid" } },
    "attachments": { "type": "array", "items": { "type": "string", "format": "uuid" } },
    "remote_was_deleted": { "type": "boolean" },
    "created_at": { "type": "string", "format": "date-time" },
    "modified_at": { "type": "string", "format": "date-time" }
  }
}