Attachments
TheAttachment
object is used to represent a file attached to a candidate.The Attachment object
Properties
id
Stringremote_id
Stringfile_name
Stringfile_url
Stringcandidate
Stringattachment_type
EnumRESUME
, COVER_LETTER
, OFFER_LETTER
, OTHER
, or - in cases where there is no clear mapping - the original value passed through.remote_data
RemoteData[]remote_was_deleted
Booleanfield_mappings
Object{"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_data": [{"path": "/attachments","data": ["Varies by platform"]}],"remote_was_deleted": true,"field_mappings": {"organization_defined_targets": {"custom_key": "custom_value"},"linked_account_defined_targets": {"custom_key": "custom_value"}}}
/attachments
Returns a list of Attachment
objects.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
candidate_id
Stringcreated_after
Stringcreated_before
Stringcursor
Stringexpand
Stringinclude_deleted_data
Booleaninclude_remote_data
Booleanmodified_after
Stringmodified_before
Stringpage_size
Integerremote_fields
Stringremote_id
Stringshow_enum_origins
String{"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_data": [{"path": "/attachments","data": ["Varies by platform"]}],"remote_was_deleted": true,"field_mappings": {"organization_defined_targets": {"custom_key": "custom_value"},"linked_account_defined_targets": {"custom_key": "custom_value"}}}]}

ApplicantStack
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
object
Breezy
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
object
CATS
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Comeet
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
String
Cornerstone TalentLink
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Fountain
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
candidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Greenhouse
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
object
Homerun
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
candidate
Stringfile_name
Stringfile_url
Stringremote_id
String
HR Cloud
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
JazzHR
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
candidate
Stringfile_name
Stringfile_url
Stringremote_id
String
JobScore
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Jobvite
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringremote_data
RemoteData[]path
stringdata
object
Lever
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Oracle Taleo
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_id
String
Recruitee
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Recruiterflow
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
candidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
SmartRecruiters
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Teamtailor
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Workable
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
object/attachments
Creates an Attachment
object with the given values.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
is_debug_mode
Booleanrun_async
BooleanBody Parameters
model
Objectremote_user_id
StringModel Parameters
file_name
Stringfile_url
Stringcandidate
Stringid
field in the Candidate table.attachment_type
EnumRESUME
, COVER_LETTER
, OFFER_LETTER
, OTHER
.integration_params
Objectlinked_account_params
Object{"model": {"file_name": "Candidate Resume","file_url": "http://alturl.com/p749b","candidate": "2872ba14-4084-492b-be96-e5eee6fc33ef","attachment_type": "RESUME"},"remote_user_id": "string"}
{"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_data": [{"path": "/attachments","data": ["Varies by platform"]}],"remote_was_deleted": true,"field_mappings": {"organization_defined_targets": {"custom_key": "custom_value"},"linked_account_defined_targets": {"custom_key": "custom_value"}}},"warnings": [{"source": {"pointer": "/age"},"title": "Unrecognized Field","detail": "An unrecognized field, age, was passed in with request data.","problem_type": "UNRECOGNIZED_FIELD"}],"errors": [{"source": {"pointer": "/model/custom_fields"},"title": "Missing Required Field","detail": "custom_fields is a required field on model.","problem_type": "MISSING_REQUIRED_FIELD"}],"logs": [{"log_id": "99433219-8017-4acd-bb3c-ceb23d663832","dashboard_view": "https://app.merge.dev/logs/99433219-8017-4acd-bb3c-ceb23d663832","log_summary": {"url": "https://harvest.greenhouse.io/v1/candidates/","method": "POST","status_code": 200}}]}

Ashby
Merge supports Passthrough Requests to this platform's API
Supported POST Query & Path Parameters
remote_user_id
StringSupported POST Body Parameters
attachment_type
Enumcandidate
Stringfile_url
String
Breezy
Merge supports Passthrough Requests to this platform's API
Supported POST Query & Path Parameters
remote_user_id
StringSupported POST Body Parameters
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
StringAdditional POST Parameters
integration_params
Objectcompany_id
Stringposition_id
String
Greenhouse
Merge supports Passthrough Requests to this platform's API
Supported POST Query & Path Parameters
remote_user_id
StringSupported POST Body Parameters
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_id
StringAdditional POST Parameters
remote_user_id
String
Lever
Merge supports Passthrough Requests to this platform's API
Supported POST Query & Path Parameters
remote_user_id
StringSupported POST Body Parameters
candidate
Stringfile_name
Stringfile_url
Stringremote_id
StringAdditional POST Parameters
remote_user_id
String
Oracle Taleo
Merge supports Passthrough Requests to this platform's API
Supported POST Query & Path Parameters
remote_user_id
StringSupported POST Body Parameters
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_id
String
Recruitee
Merge supports Passthrough Requests to this platform's API
Supported POST Query & Path Parameters
remote_user_id
StringSupported POST Body Parameters
candidate
Stringfile_name
Stringfile_url
Stringremote_id
String
Teamtailor
Merge supports Passthrough Requests to this platform's API
Supported POST Query & Path Parameters
remote_user_id
StringSupported POST Body Parameters
candidate
Stringfile_name
Stringfile_url
Stringremote_id
String
UKG Pro Recruiting
Merge supports Passthrough Requests to this platform's API
Supported POST Query & Path Parameters
remote_user_id
StringSupported POST Body Parameters
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_id
String
Workable
Merge supports Passthrough Requests to this platform's API
Supported POST Query & Path Parameters
remote_user_id
StringSupported POST Body Parameters
attachment_type
Enumcandidate
Stringfile_url
Stringremote_id
StringAdditional POST Parameters
model
Stringremote_user_id
String/attachments/{id}
Returns an Attachment
object with the given id
.
Header Parameters
Authorization
StringX-Account-Token
StringQuery & Path Parameters
expand
Stringid
Stringinclude_remote_data
Booleanremote_fields
Stringshow_enum_origins
String{"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_data": [{"path": "/attachments","data": ["Varies by platform"]}],"remote_was_deleted": true,"field_mappings": {"organization_defined_targets": {"custom_key": "custom_value"},"linked_account_defined_targets": {"custom_key": "custom_value"}}}

ApplicantStack
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
object
Breezy
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
object
CATS
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Comeet
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
String
Cornerstone TalentLink
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Fountain
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
candidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Greenhouse
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
object
Homerun
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
candidate
Stringfile_name
Stringfile_url
Stringremote_id
String
HR Cloud
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
JazzHR
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
candidate
Stringfile_name
Stringfile_url
Stringremote_id
String
JobScore
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Jobvite
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringremote_data
RemoteData[]path
stringdata
object
Lever
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Oracle Taleo
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_id
String
Recruitee
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Recruiterflow
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
candidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
SmartRecruiters
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Teamtailor
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Workable
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
object/attachments/meta/post
Returns metadata for Attachment
POSTs.
Header Parameters
Authorization
StringX-Account-Token
String{"request_schema": {},"status": {"linked_account_status": "string","can_make_request": true},"has_conditional_params": true,"has_required_linked_account_params": true}

ApplicantStack
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
object
Breezy
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
object
CATS
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Comeet
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
String
Cornerstone TalentLink
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Fountain
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
candidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Greenhouse
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
object
Homerun
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
candidate
Stringfile_name
Stringfile_url
Stringremote_id
String
HR Cloud
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
JazzHR
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
candidate
Stringfile_name
Stringfile_url
Stringremote_id
String
JobScore
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Jobvite
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringremote_data
RemoteData[]path
stringdata
object
Lever
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Oracle Taleo
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_id
String
Recruitee
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Recruiterflow
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
candidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
SmartRecruiters
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Teamtailor
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
objectremote_id
String
Workable
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
object