Attachments
The Attachment object is used to represent a file attached to a candidate.
Properties
idString
Required
remote_idString
Optional
The third-party API ID of the matching object.
file_nameString
Optional
The attachment's name.
file_urlString
Optional
The attachment's url.
candidateString
Optional
attachment_typeEnum
Optional
The attachment's type. Possible values include: RESUME, COVER_LETTER, OFFER_LETTER, OTHER. In cases where there is no clear mapping, the original value passed through will be returned.
remote_was_deletedBoolean
Required
created_atString
Required
modified_atString
Required
This is the datetime that this object was last updated by Merge
field_mappingsObject
Optional
remote_dataRemoteData[]
Optional
The Attachment object
JSON
{
  "id": "c640b80b-fac9-409f-aa19-1f9221aec445",
  "remote_id": "11167",
  "file_name": "Candidate Resume",
  "file_url": "http://alturl.com/p749b",
  "candidate": "2872ba14-4084-492b-be96-e5eee6fc33ef",
  "attachment_type": "RESUME",
  "remote_was_deleted": true,
  "created_at": "2021-09-15T00:00:00Z",
  "modified_at": "2021-10-16T00:00:00Z",
Show advanced fields
}
GET
/attachments

https://api.merge.dev/api/ats/v1/attachments

US
EU

Returns a list of Attachment objects.


Header Parameters
AuthorizationString
Required
Token-based authentication with required prefix "Bearer"
X-Account-TokenString
Required
Token identifying the end user.
Query & Path Parameters
candidate_idString
Optional
If provided, will only return attachments for this candidate.
created_afterString
Optional
If provided, will only return objects created after this datetime.
created_beforeString
Optional
If provided, will only return objects created before this datetime.
cursorString
Optional
The pagination cursor value.
expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
include_deleted_dataBoolean
Optional
Whether to include data that was marked as deleted by third party webhooks.
include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
modified_afterString
Optional
If provided, only objects synced by Merge after this date time will be returned.
modified_beforeString
Optional
If provided, only objects synced by Merge before this date time will be returned.
page_sizeInteger
Optional
Number of results to return per page.
remote_fieldsString
Optional
Deprecated. Use show_enum_origins.
remote_idString
Optional
The API provider's ID for the given object.
show_enum_originsString
Optional
Which fields should be returned in non-normalized form.
Response
JSON
{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "id": "c640b80b-fac9-409f-aa19-1f9221aec445",
      "remote_id": "11167",
      "file_name": "Candidate Resume",
      "file_url": "http://alturl.com/p749b",
      "candidate": "2872ba14-4084-492b-be96-e5eee6fc33ef",
      "attachment_type": "RESUME",
      "remote_was_deleted": true,
      "created_at": "2021-09-15T00:00:00Z",
      "modified_at": "2021-10-16T00:00:00Z",
Show advanced fields
    }
  ]
}
Field support by platform
ApplicantStack
ApplicantStack

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum
candidateString
file_nameString
file_urlString
remote_dataRemoteData[]
pathstring
datastring
Breezy
Breezy

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum
candidateString
file_nameString
file_urlString
remote_dataRemoteData[]
pathstring
datastring
CATS
CATS

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum
candidateString
file_nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
Comeet
Comeet

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum
candidateString
file_nameString
file_urlString
Cornerstone TalentLink
Cornerstone TalentLink

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum
candidateString
file_nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
Fountain
Fountain

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

candidateString
file_nameString
file_urlString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
Greenhouse
Greenhouse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum
candidateString
file_nameString
file_urlString
remote_dataRemoteData[]
pathstring
datastring
Homerun
Homerun

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

candidateString
file_nameString
file_urlString
remote_idString
HR Cloud
HR Cloud

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum
candidateString
file_nameString
file_urlString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
iCIMS
iCIMS

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum
candidateString
file_urlString
JobScore
JobScore

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum
candidateString
file_nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
Jobvite
Jobvite

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum
candidateString
file_nameString
remote_dataRemoteData[]
pathstring
datastring
Lever
Lever

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum
candidateString
file_nameString
file_urlString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
Oracle Fusion - Recruiting Cloud
Oracle Fusion - Recruiting Cloud

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum
candidateString
file_nameString
file_urlString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
Oracle Taleo
Oracle Taleo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum
candidateString
file_nameString
file_urlString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
Recruitee
Recruitee

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum
candidateString
file_nameString
file_urlString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
Recruiterflow
Recruiterflow

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

candidateString
file_nameString
file_urlString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
SmartRecruiters
SmartRecruiters

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum
candidateString
file_nameString
file_urlString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
Teamtailor
Teamtailor

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum
candidateString
file_nameString
file_urlString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
Workable
Workable

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum
candidateString
file_urlString
remote_dataRemoteData[]
pathstring
datastring
Not seeing a platform that you're looking for? Submit a request for it here.
Hint: Use the /linked-accounts endpoint to pull platform support information.
POST
/attachments

https://api.merge.dev/api/ats/v1/attachments

US
EU

Creates an Attachment object with the given values.


Header Parameters
AuthorizationString
Required
Token-based authentication with required prefix "Bearer"
X-Account-TokenString
Required
Token identifying the end user.
Query & Path Parameters
is_debug_modeBoolean
Optional
Whether to include debug fields (such as log file links) in the response.
run_asyncBoolean
Optional
Whether or not third-party updates should be run asynchronously.
Body Parameters
modelObject
Required
Find available fields below under “Model Parameters”.
remote_user_idString
Required
Model Parameters
View app-specific writable fields under “Field support by platform” in this section.
file_nameString
The attachment's name.
file_urlString
The attachment's url.
candidateString
Must pass in a valid Merge ID, which can be obtained from the id field in the Candidate object.
attachment_typeEnum
The attachment's type. Must pass in one of the following choices: RESUME, COVER_LETTER, OFFER_LETTER, OTHER.
integration_paramsObject
linked_account_paramsObject
POST v1/attachments
JSON
{
  "model": {
    "file_name": "Candidate Resume",
    "file_url": "http://alturl.com/p749b",
    "candidate": "2872ba14-4084-492b-be96-e5eee6fc33ef",
    "attachment_type": "RESUME"
  },
  "remote_user_id": "string"
}
Response
JSON
{
  "model": {
    "id": "c640b80b-fac9-409f-aa19-1f9221aec445",
    "remote_id": "11167",
    "file_name": "Candidate Resume",
    "file_url": "http://alturl.com/p749b",
    "candidate": "2872ba14-4084-492b-be96-e5eee6fc33ef",
    "attachment_type": "RESUME",
    "remote_was_deleted": true,
    "created_at": "2021-09-15T00:00:00Z",
    "modified_at": "2021-10-16T00:00:00Z",
Show advanced fields
  }
}
Field support by platform
Ashby
Ashby

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters

attachment_typeEnum
Optional
candidateString
Required
file_urlString
Required
Breezy
Breezy

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters

attachment_typeEnum
Optional
candidateString
Required
file_nameString
Optional
file_urlString
Required

Additional POST Parameters

integration_paramsObject
Required
company_idString
Required
position_idString
Required
Greenhouse
Greenhouse

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters

attachment_typeEnum
Optional
candidateString
Required
file_nameString
Required
file_urlString
Required
remote_idString
Optional

Additional POST Parameters

remote_user_idString
Required
iCIMS
iCIMS

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters

attachment_typeEnum
Required
candidateString
Required
file_urlString
Required
Lever
Lever

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters

candidateString
Required
file_nameString
Optional
file_urlString
Required
remote_idString
Optional

Additional POST Parameters

remote_user_idString
Required
Oracle Fusion - Recruiting Cloud
Oracle Fusion - Recruiting Cloud

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters

attachment_typeEnum
Optional
candidateString
Required
file_nameString
Required
file_urlString
Required
remote_idString
Optional
Oracle Taleo
Oracle Taleo

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters

attachment_typeEnum
Optional
candidateString
Optional
file_nameString
Optional
file_urlString
Optional
remote_idString
Optional
Recruitee
Recruitee

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters

candidateString
Required
file_nameString
Optional
file_urlString
Required
remote_idString
Optional
Teamtailor
Teamtailor

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters

candidateString
Required
file_nameString
Optional
file_urlString
Required
remote_idString
Optional
UKG Pro Recruiting
UKG Pro Recruiting

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters

attachment_typeEnum
Optional
candidateString
Optional
file_nameString
Optional
file_urlString
Optional
remote_idString
Optional
Workable
Workable

Merge supports Passthrough Requests to this platform's API

Supported POST Model Parameters

attachment_typeEnum
Optional
candidateString
Required
file_urlString
Required
remote_idString
Optional
Not seeing a platform that you're looking for? Submit a request for it here.
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET
/attachments/{id}

https://api.merge.dev/api/ats/v1/attachments/{id}

US
EU

Returns an Attachment object with the given id.


Header Parameters
AuthorizationString
Required
Token-based authentication with required prefix "Bearer"
X-Account-TokenString
Required
Token identifying the end user.
Query & Path Parameters
expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
idString
Required
include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.
remote_fieldsString
Optional
Deprecated. Use show_enum_origins.
show_enum_originsString
Optional
Which fields should be returned in non-normalized form.
Response
JSON
{
  "id": "c640b80b-fac9-409f-aa19-1f9221aec445",
  "remote_id": "11167",
  "file_name": "Candidate Resume",
  "file_url": "http://alturl.com/p749b",
  "candidate": "2872ba14-4084-492b-be96-e5eee6fc33ef",
  "attachment_type": "RESUME",
  "remote_was_deleted": true,
  "created_at": "2021-09-15T00:00:00Z",
  "modified_at": "2021-10-16T00:00:00Z",
Show advanced fields
}
Field support by platform
ApplicantStack
ApplicantStack

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum
candidateString
file_nameString
file_urlString
remote_dataRemoteData[]
pathstring
datastring
Breezy
Breezy

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum
candidateString
file_nameString
file_urlString
remote_dataRemoteData[]
pathstring
datastring
CATS
CATS

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum
candidateString
file_nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
Comeet
Comeet

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum
candidateString
file_nameString
file_urlString
Cornerstone TalentLink
Cornerstone TalentLink

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum
candidateString
file_nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
Fountain
Fountain

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

candidateString
file_nameString
file_urlString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
Greenhouse
Greenhouse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum
candidateString
file_nameString
file_urlString
remote_dataRemoteData[]
pathstring
datastring
Homerun
Homerun

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

candidateString
file_nameString
file_urlString
remote_idString
HR Cloud
HR Cloud

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum
candidateString
file_nameString
file_urlString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
iCIMS
iCIMS

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum
candidateString
file_urlString
JobScore
JobScore

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum
candidateString
file_nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
Jobvite
Jobvite

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum
candidateString
file_nameString
remote_dataRemoteData[]
pathstring
datastring
Lever
Lever

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum
candidateString
file_nameString
file_urlString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
Oracle Fusion - Recruiting Cloud
Oracle Fusion - Recruiting Cloud

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum
candidateString
file_nameString
file_urlString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
Oracle Taleo
Oracle Taleo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum
candidateString
file_nameString
file_urlString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
Recruitee
Recruitee

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum
candidateString
file_nameString
file_urlString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
Recruiterflow
Recruiterflow

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

candidateString
file_nameString
file_urlString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
SmartRecruiters
SmartRecruiters

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum
candidateString
file_nameString
file_urlString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
Teamtailor
Teamtailor

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum
candidateString
file_nameString
file_urlString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
Workable
Workable

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum
candidateString
file_urlString
remote_dataRemoteData[]
pathstring
datastring
Not seeing a platform that you're looking for? Submit a request for it here.
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET
/attachments/meta/post

https://api.merge.dev/api/ats/v1/attachments/meta/post

US
EU

Returns metadata for Attachment POSTs.


Header Parameters
AuthorizationString
Required
Token-based authentication with required prefix "Bearer"
X-Account-TokenString
Required
Token identifying the end user.
Response
JSON
{
  "request_schema": {},
  "remote_field_classes": {},
  "status": {
    "linked_account_status": "COMPLETE",
    "can_make_request": true
  },
  "has_conditional_params": true,
  "has_required_linked_account_params": true
}
Field support by platform
ApplicantStack
ApplicantStack

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum
candidateString
file_nameString
file_urlString
remote_dataRemoteData[]
pathstring
datastring
Breezy
Breezy

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum
candidateString
file_nameString
file_urlString
remote_dataRemoteData[]
pathstring
datastring
CATS
CATS

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum
candidateString
file_nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
Comeet
Comeet

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum
candidateString
file_nameString
file_urlString
Cornerstone TalentLink
Cornerstone TalentLink

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum
candidateString
file_nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
Fountain
Fountain

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

candidateString
file_nameString
file_urlString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
Greenhouse
Greenhouse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum
candidateString
file_nameString
file_urlString
remote_dataRemoteData[]
pathstring
datastring
Homerun
Homerun

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

candidateString
file_nameString
file_urlString
remote_idString
HR Cloud
HR Cloud

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum
candidateString
file_nameString
file_urlString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
iCIMS
iCIMS

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum
candidateString
file_urlString
JobScore
JobScore

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum
candidateString
file_nameString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
Jobvite
Jobvite

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum
candidateString
file_nameString
remote_dataRemoteData[]
pathstring
datastring
Lever
Lever

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum
candidateString
file_nameString
file_urlString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
Oracle Fusion - Recruiting Cloud
Oracle Fusion - Recruiting Cloud

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum
candidateString
file_nameString
file_urlString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
Oracle Taleo
Oracle Taleo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum
candidateString
file_nameString
file_urlString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
Recruitee
Recruitee

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum
candidateString
file_nameString
file_urlString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
Recruiterflow
Recruiterflow

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

candidateString
file_nameString
file_urlString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
SmartRecruiters
SmartRecruiters

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum
candidateString
file_nameString
file_urlString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
Teamtailor
Teamtailor

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum
candidateString
file_nameString
file_urlString
remote_dataRemoteData[]
pathstring
datastring
remote_idString
Workable
Workable

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum
candidateString
file_urlString
remote_dataRemoteData[]
pathstring
datastring
Not seeing a platform that you're looking for? Submit a request for it here.
Hint: Use the /linked-accounts endpoint to pull platform support information.
Previous
Applications
Next Up
Candidates