For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Logo
Resources
Log inGet a demo
Get startedAPI referenceImplementation
Get startedAPI referenceImplementation
    • Overview
          • The Candidate object
          • GET/candidates
          • POST/candidates
          • GET/candidates/{id}
          • PATCH/candidates/{id}
          • POST/candidates/ignore/{model_id}
          • GET/candidates/meta/patch/{id}
          • GET/candidates/meta/post

Get started

  • Overview
  • Introduction
  • Unified API
  • Linked Account
  • Merge Link
  • Use cases

Implementation

  • Sandboxes
  • SDKs
  • API access
  • Syncing data
  • Writing data
  • Data minimization
  • Supplemental data
  • Errors
  • Integration metadata

API reference

  • ATS
  • HRIS
  • Accounting
  • Ticketing
  • CRM
  • File Storage
  • Knowledge Base
  • Chat

Resources

  • Help Center
  • Merge.dev
  • Changelog
© Merge 2026Terms of usePrivacy policy
UnifiedAgent HandlerGateway
UnifiedAgent HandlerGateway
Resources
Log inGet a demo
Common ModelsCandidates

The Candidate object

The Candidate Object
1{
2  "id": "string",
3  "remote_id": "string",
4  "created_at": "2023-01-01T00:00:00Z",
5  "modified_at": "2023-01-01T00:00:00Z",
6  "first_name": "string",
7  "last_name": "string",
8  "company": "string",
9  "title": "string",
10  "remote_created_at": "2023-01-01T00:00:00Z",
11  "remote_updated_at": "2023-01-01T00:00:00Z",
12  "last_interaction_at": "2023-01-01T00:00:00Z",
13  "is_private": true,
14  "can_email": true,
15  "locations": [
16    "string"
17  ],
18  "phone_numbers": [
19    {
20      "created_at": "2023-01-01T00:00:00Z",
21      "modified_at": "2023-01-01T00:00:00Z",
22      "value": "string",
23      "phone_number_type": "HOME",
24      "remote_was_deleted": true
25    }
26  ],
27  "email_addresses": [
28    {
29      "created_at": "2023-01-01T00:00:00Z",
30      "modified_at": "2023-01-01T00:00:00Z",
31      "value": "string",
32      "email_address_type": "PERSONAL",
33      "remote_was_deleted": true
34    }
35  ],
36  "urls": [
37    {
38      "created_at": "2023-01-01T00:00:00Z",
39      "modified_at": "2023-01-01T00:00:00Z",
40      "value": "string",
41      "url_type": "PERSONAL",
42      "remote_was_deleted": true
43    }
44  ],
45  "tags": [
46    "string"
47  ],
48  "applications": [
49    "string"
50  ],
51  "attachments": [
52    "string"
53  ],
54  "remote_was_deleted": true,
55  "field_mappings": {
56    "organization_defined_targets": {
57      "string": {}
58    },
59    "linked_account_defined_targets": {
60      "string": {}
61    }
62  },
63  "remote_data": [
64    {
65      "path": "string",
66      "data": {}
67    }
68  ]
69}
Was this page helpful?
Previous

/attachments/meta/post

Next

/candidates

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.

idstringOptionalRead-onlyformat: "uuid"
remote_idstring or nullOptional
created_atdatetimeOptionalRead-only
The datetime that this object was created by Merge.
modified_atdatetimeOptionalRead-only
The datetime that this object was modified by Merge.
first_namestring or nullOptional
The candidate's first name.
last_namestring or nullOptional
The candidate's last name.
companystring or nullOptional
The candidate's current company.
titlestring or nullOptional
The candidate's current title.
remote_created_atdatetime or nullOptional
When the third party's candidate was created.
remote_updated_atdatetime or nullOptional
When the third party's candidate was updated.
last_interaction_atdatetime or nullOptional
When the most recent interaction with the candidate occurred.
is_privateboolean or nullOptional
Whether or not the candidate is private.
can_emailboolean or nullOptional
Whether or not the candidate can be emailed.
locationslist of strings or nullOptional
The candidate's locations.
phone_numberslist of objectsOptional
email_addresseslist of objectsOptional
urlslist of objectsOptional
tagslist of stringsOptional
applicationslist of stringsOptional
attachmentslist of stringsOptional
remote_was_deletedbooleanOptional
field_mappingsobject or nullOptionalRead-only
remote_datalist of objects or nullOptionalRead-only