Attachments
The Attachment object is used to represent a file attached to a candidate.
Properties

idUUID
Required

remote_idString
Optional
The third-party API ID of the matching object.

created_atDateTime (ISO 8601)
Required

modified_atDateTime (ISO 8601)
Required
This is the datetime that this object was last updated by Merge

file_nameString
Optional
The attachment's name.

file_urlString
Optional
The attachment's url.

candidateUUID
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

field_mappingsObject
Optional

remote_dataRemoteData[]
Optional


GET
/attachments

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

US
EU

Returns a list of Attachment objects.


Query & Path Parameters

candidate_idString
Optional
If provided, will only return attachments for this candidate.

created_afterDateTime (ISO 8601)
Optional
If provided, will only return objects created after this datetime.

created_beforeDateTime (ISO 8601)
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_afterDateTime (ISO 8601)
Optional
If provided, only objects synced by Merge after this date time will be returned.

modified_beforeDateTime (ISO 8601)
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
A comma separated list of enum field names you'd like returned as original values, rather than normalized to Merge's standard enum values. Learn more

Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
ApplicantStack
ApplicantStack
Breezy
Breezy
CATS
CATS
Comeet
Comeet
Cornerstone TalentLink
Cornerstone TalentLink
Fountain
Fountain
Greenhouse
Greenhouse
Homerun
Homerun
HR Cloud
HR Cloud
iCIMS
iCIMS
JobScore
JobScore
Jobvite
Jobvite
Lever
Lever
Oracle Fusion - Recruiting Cloud
Oracle Fusion - Recruiting Cloud
Oracle Taleo
Oracle Taleo
Pinpoint
Pinpoint
Recruiterflow
Recruiterflow
SmartRecruiters
SmartRecruiters
Teamtailor
Teamtailor
Tellent
Tellent
Workable
Workable
Zoho Recruit
Zoho Recruit
POST
/attachments

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

US
EU

Creates an Attachment object with the given values.


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.

candidateUUID
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

Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
Ashby
Ashby
Breezy
Breezy
Greenhouse
Greenhouse
iCIMS
iCIMS
Lever
Lever
Oracle Fusion - Recruiting Cloud
Oracle Fusion - Recruiting Cloud
Oracle Taleo
Oracle Taleo
SmartRecruiters
SmartRecruiters
Teamtailor
Teamtailor
Tellent
Tellent
UKG Pro Recruiting
UKG Pro Recruiting
Workable
Workable
Workday
Workday
To include the correct model fields when making POST requests, use the GET /attachments/meta/post endpoint. Learn more in our /meta guide.
GET
/attachments/{id}

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

US
EU

Returns an Attachment object with the given id.


Query & Path Parameters

expandString
Optional
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

idUUID
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
A comma separated list of enum field names you'd like returned as original values, rather than normalized to Merge's standard enum values. Learn more

Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
ApplicantStack
ApplicantStack
Breezy
Breezy
CATS
CATS
Comeet
Comeet
Cornerstone TalentLink
Cornerstone TalentLink
Fountain
Fountain
Greenhouse
Greenhouse
Homerun
Homerun
HR Cloud
HR Cloud
iCIMS
iCIMS
JobScore
JobScore
Jobvite
Jobvite
Lever
Lever
Oracle Fusion - Recruiting Cloud
Oracle Fusion - Recruiting Cloud
Oracle Taleo
Oracle Taleo
Pinpoint
Pinpoint
Recruiterflow
Recruiterflow
SmartRecruiters
SmartRecruiters
Teamtailor
Teamtailor
Tellent
Tellent
Workable
Workable
Zoho Recruit
Zoho Recruit
GET
/attachments/meta/post

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

US
EU

Returns metadata for Attachment POSTs.


Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
ApplicantStack
ApplicantStack
Breezy
Breezy
CATS
CATS
Comeet
Comeet
Cornerstone TalentLink
Cornerstone TalentLink
Fountain
Fountain
Greenhouse
Greenhouse
Homerun
Homerun
HR Cloud
HR Cloud
iCIMS
iCIMS
JobScore
JobScore
Jobvite
Jobvite
Lever
Lever
Oracle Fusion - Recruiting Cloud
Oracle Fusion - Recruiting Cloud
Oracle Taleo
Oracle Taleo
Pinpoint
Pinpoint
Recruiterflow
Recruiterflow
SmartRecruiters
SmartRecruiters
Teamtailor
Teamtailor
Tellent
Tellent
Workable
Workable
Zoho Recruit
Zoho Recruit