Attachment
object is used to represent a file attached to a candidate.id
Stringremote_id
Stringfile_name
Stringfile_url
Stringcandidate
Stringattachment_type
EnumRESUME
, COVER_LETTER
, OFFER_LETTER
, OTHER
. In cases where there is no clear mapping, the original value passed through will be returned.remote_was_deleted
Booleancreated_at
Stringmodified_at
Stringfield_mappings
Objectremote_data
RemoteData[]{"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}
https://api.merge.dev/api/ats/v1/attachments
Returns a list of Attachment
objects.
Authorization
StringX-Account-Token
Stringcandidate_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_was_deleted": true,"created_at": "2021-09-15T00:00:00Z","modified_at": "2021-10-16T00:00:00Z",Show advanced fields}]}

Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
string
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
string
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
candidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
string
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
candidate
Stringfile_name
Stringfile_url
Stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_url
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringremote_data
RemoteData[]path
stringdata
string
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
candidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringhttps://api.merge.dev/api/ats/v1/attachments
Creates an Attachment
object with the given values.
Authorization
StringX-Account-Token
Stringis_debug_mode
Booleanrun_async
Booleanmodel
Objectremote_user_id
Stringfile_name
Stringfile_url
Stringcandidate
Stringid
field in the Candidate object.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_was_deleted": true,"created_at": "2021-09-15T00:00:00Z","modified_at": "2021-10-16T00:00:00Z",Show advanced fields}}

Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
attachment_type
Enumcandidate
Stringfile_url
String
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
StringAdditional POST Parameters
integration_params
Objectcompany_id
Stringposition_id
String
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_id
StringAdditional POST Parameters
remote_user_id
String
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
attachment_type
Enumcandidate
Stringfile_url
String
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
candidate
Stringfile_name
Stringfile_url
Stringremote_id
StringAdditional POST Parameters
remote_user_id
String
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
candidate
Stringfile_name
Stringfile_url
Stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
candidate
Stringfile_name
Stringfile_url
Stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported POST Model Parameters
attachment_type
Enumcandidate
Stringfile_url
Stringremote_id
Stringhttps://api.merge.dev/api/ats/v1/attachments/{id}
Returns an Attachment
object with the given id
.
Authorization
StringX-Account-Token
Stringexpand
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_was_deleted": true,"created_at": "2021-09-15T00:00:00Z","modified_at": "2021-10-16T00:00:00Z",Show advanced fields}

Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
string
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
string
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
candidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
string
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
candidate
Stringfile_name
Stringfile_url
Stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_url
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringremote_data
RemoteData[]path
stringdata
string
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
candidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringhttps://api.merge.dev/api/ats/v1/attachments/meta/post
Returns metadata for Attachment
POSTs.
Authorization
StringX-Account-Token
String{"request_schema": {},"remote_field_classes": {},"status": {"linked_account_status": "COMPLETE","can_make_request": true},"has_conditional_params": true,"has_required_linked_account_params": true}

Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
string
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
string
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
candidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
string
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
candidate
Stringfile_name
Stringfile_url
Stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_url
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringremote_data
RemoteData[]path
stringdata
string
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
candidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
attachment_type
Enumcandidate
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
string