> This page is for Unified.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.merge.dev/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.merge.dev/_mcp/server.

The `Candidate` object is used to represent profile information about a given Candidate. Because it is specific to a Candidate, this information stays constant across applications.

### The Candidate Object

```json
{
  "id": "string",
  "remote_id": "string",
  "created_at": "2023-01-01T00:00:00Z",
  "modified_at": "2023-01-01T00:00:00Z",
  "first_name": "string",
  "last_name": "string",
  "company": "string",
  "title": "string",
  "remote_created_at": "2023-01-01T00:00:00Z",
  "remote_updated_at": "2023-01-01T00:00:00Z",
  "last_interaction_at": "2023-01-01T00:00:00Z",
  "is_private": true,
  "can_email": true,
  "locations": [
    "string"
  ],
  "phone_numbers": [
    {
      "created_at": "2023-01-01T00:00:00Z",
      "modified_at": "2023-01-01T00:00:00Z",
      "value": "string",
      "phone_number_type": "HOME",
      "remote_was_deleted": true
    }
  ],
  "email_addresses": [
    {
      "created_at": "2023-01-01T00:00:00Z",
      "modified_at": "2023-01-01T00:00:00Z",
      "value": "string",
      "email_address_type": "PERSONAL",
      "remote_was_deleted": true
    }
  ],
  "urls": [
    {
      "created_at": "2023-01-01T00:00:00Z",
      "modified_at": "2023-01-01T00:00:00Z",
      "value": "string",
      "url_type": "PERSONAL",
      "remote_was_deleted": true
    }
  ],
  "tags": [
    "string"
  ],
  "applications": [
    "string"
  ],
  "attachments": [
    "string"
  ],
  "remote_was_deleted": true,
  "field_mappings": {
    "organization_defined_targets": {
      "string": {}
    },
    "linked_account_defined_targets": {
      "string": {}
    }
  },
  "remote_data": [
    {
      "path": "string",
      "data": {}
    }
  ]
}
```

### Schema (`Candidate`)

```yaml
components:
  schemas:
    PhoneNumberTypeEnum:
      type: string
      enum:
        - HOME
        - WORK
        - MOBILE
        - SKYPE
        - OTHER
      title: PhoneNumberTypeEnum
    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

        ### 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.
      title: PhoneNumber
    EmailAddressTypeEnum:
      type: string
      enum:
        - PERSONAL
        - WORK
        - OTHER
      title: EmailAddressTypeEnum
    EmailAddress:
      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'
          format: email
          maxLength: 254
          description: The email address.
        email_address_type:
          oneOf:
            - $ref: '#/components/schemas/EmailAddressTypeEnum'
            - type: 'null'
          description: The type of email address.
        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 EmailAddress Object

        ### Description

        The `EmailAddress` object is used to represent a candidate's email
        address.

        ### Usage Example

        Fetch from the `GET Candidate` endpoint and view their email addresses.
      title: EmailAddress
    UrlTypeEnum:
      type: string
      enum:
        - PERSONAL
        - COMPANY
        - PORTFOLIO
        - BLOG
        - SOCIAL_MEDIA
        - OTHER
        - JOB_POSTING
      title: UrlTypeEnum
    Url:
      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'
          format: uri
          maxLength: 2000
          description: The site's url.
        url_type:
          oneOf:
            - $ref: '#/components/schemas/UrlTypeEnum'
            - type: 'null'
          description: The type of site.
        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 Url Object

        ### Description

        The `Url` object is used to represent hyperlinks associated with the
        parent model.

        ### Usage Example

        Fetch from the `GET Candidate` endpoint and view their website urls.
      title: Url
    CandidateFieldMappings:
      type: object
      properties:
        organization_defined_targets:
          type: object
          additionalProperties:
            description: Any type
        linked_account_defined_targets:
          type: object
          additionalProperties:
            description: Any type
      title: CandidateFieldMappings
    RemoteData:
      type: object
      properties:
        path:
          type: string
          description: The third-party API path that is being called.
        data:
          description: >-
            The data returned from the third-party for this object in its
            original, unnormalized format.
      required:
        - path
      description: >-
        # The RemoteData Object

        ### Description

        The `RemoteData` object is used to represent the full data pulled from
        the third-party API for an object.


        ### Usage Example

        TODO
      title: RemoteData
    Candidate:
      type: object
      properties:
        id:
          type: string
          format: uuid
        remote_id:
          type:
            - string
            - 'null'
          description: The third-party API ID of the matching object.
        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.
        first_name:
          type:
            - string
            - 'null'
          description: The candidate's first name.
        last_name:
          type:
            - string
            - 'null'
          description: The candidate's last name.
        company:
          type:
            - string
            - 'null'
          description: The candidate's current company.
        title:
          type:
            - string
            - 'null'
          description: The candidate's current title.
        remote_created_at:
          type:
            - string
            - 'null'
          format: date-time
          description: When the third party's candidate was created.
        remote_updated_at:
          type:
            - string
            - 'null'
          format: date-time
          description: When the third party's candidate was updated.
        last_interaction_at:
          type:
            - string
            - 'null'
          format: date-time
          description: When the most recent interaction with the candidate occurred.
        is_private:
          type:
            - boolean
            - 'null'
          description: Whether or not the candidate is private.
        can_email:
          type:
            - boolean
            - 'null'
          description: Whether or not the candidate can be emailed.
        locations:
          type:
            - array
            - 'null'
          items:
            type: string
          description: The candidate's locations.
        phone_numbers:
          type: array
          items:
            $ref: '#/components/schemas/PhoneNumber'
        email_addresses:
          type: array
          items:
            $ref: '#/components/schemas/EmailAddress'
        urls:
          type: array
          items:
            $ref: '#/components/schemas/Url'
        tags:
          type: array
          items:
            type: string
          description: Array of `Tag` names as strings.
        applications:
          type: array
          items:
            type: string
            format: uuid
          description: Array of `Application` object IDs.
        attachments:
          type: array
          items:
            type: string
            format: uuid
          description: Array of `Attachment` object IDs.
        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/).
        field_mappings:
          oneOf:
            - $ref: '#/components/schemas/CandidateFieldMappings'
            - type: 'null'
        remote_data:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/RemoteData'
      title: Candidate
```