Attachment
object is used to represent a file attached to a candidate.id
UUIDremote_id
Stringcreated_at
DateTime (ISO 8601)modified_at
DateTime (ISO 8601)file_name
Stringfile_url
Stringcandidate
UUIDattachment_type
EnumRESUME
, COVER_LETTER
, OFFER_LETTER
, OTHER
. In cases where there is no clear mapping, the original value passed through will be returned. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.remote_was_deleted
Booleanfield_mappings
Objectremote_data
RemoteData[]RemoteData
object is used to represent the full data pulled from the third-party API for an object.path
Stringdata
Anyhttps://api.merge.dev/api/ats/v1/attachments
Returns a list of Attachment
objects.
candidate_id
Stringcreated_after
DateTime (ISO 8601)created_before
DateTime (ISO 8601)cursor
Stringexpand
Stringinclude_deleted_data
Booleaninclude_remote_data
Booleaninclude_shell_data
Booleanmodified_after
DateTime (ISO 8601)modified_before
DateTime (ISO 8601)page_size
Integerremote_fields
Stringremote_id
Stringshow_enum_origins
String
Supported Response Fields
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
string
Supported Response Fields
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Supported Response Fields
attachment_type
Enumcandidate
UUIDfile_url
Stringremote_id
String
Supported Response Fields
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
string
Supported Response Fields
candidate
UUIDfile_name
Stringfile_url
Stringremote_id
String
Supported Response Fields
attachment_type
Enumcandidate
UUIDfile_name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Supported Response Fields
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
String
Supported Response Fields
attachment_type
Enumcandidate
UUIDfile_name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Supported Response Fields
candidate
UUIDfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Supported Response Fields
file_name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Supported Response Fields
candidate
UUIDfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Supported Response Fields
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
string
Supported Response Fields
candidate
UUIDfile_name
Stringfile_url
Stringremote_id
String
Supported Response Fields
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Supported Response Fields
attachment_type
Enumcandidate
UUIDfile_url
String
Supported Response Fields
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
Stringremote_id
String
Supported Response Fields
attachment_type
Enumcandidate
UUIDfile_name
Stringremote_data
RemoteData[]path
stringdata
string
Supported Response Fields
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
string
Supported Response Fields
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Supported Response Fields
candidate
UUIDfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Supported Response Fields
attachment_type
Enumcandidate
UUIDfile_name
Stringremote_data
RemoteData[]path
stringdata
string
Supported Response Fields
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Supported Response Fields
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Supported Response Fields
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
string
Supported Response Fields
candidate
UUIDfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Supported Response Fields
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Supported Response Fields
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Supported Response Fields
candidate
UUIDfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Supported Response Fields
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Supported Response Fields
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Supported Response Fields
candidate
UUIDfile_name
String
Supported Response Fields
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Supported Response Fields
candidate
UUIDfile_name
Stringfile_url
Stringremote_id
String
Supported Response Fields
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
string
Supported Response Fields
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Supported Response Fields
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringhttps://api.merge.dev/api/ats/v1/attachments
Creates an Attachment
object with the given values.
is_debug_mode
Booleanrun_async
Booleanmodel
Objectremote_user_id
Stringfile_name
Stringfile_url
Stringcandidate
UUIDid
field in the Candidate object. For specified integrations, you may pass in the Candidate model directly and Merge will automatically handle deduplication of existing objects.attachment_type
EnumRESUME
, COVER_LETTER
, OFFER_LETTER
, OTHER
.integration_params
Objectlinked_account_params
Object
Supported POST Model Parameters
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
Stringremote_id
String
Supported POST Model Parameters
candidate
UUIDfile_name
Stringfile_url
Stringremote_id
String
Supported POST Model Parameters
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
StringAdditional POST Parameters
integration_params
Objectcompany_id
Stringposition_id
String
Supported POST Model Parameters
candidate
UUIDfile_name
Stringfile_url
Stringremote_id
String
Supported POST Model Parameters
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
Stringremote_id
StringAdditional POST Parameters
integration_params
Stringremote_user_id
String
Supported POST Model Parameters
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
Stringremote_id
StringAdditional POST Parameters
remote_user_id
String
Supported POST Model Parameters
attachment_type
Enumcandidate
UUIDfile_url
String
Supported POST Model Parameters
candidate
UUIDfile_name
Stringfile_url
Stringremote_id
StringAdditional POST Parameters
remote_user_id
String
Supported POST Model Parameters
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
Stringremote_id
String
Supported POST Model Parameters
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
Stringremote_id
String
Supported POST Model Parameters
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
String
Supported POST Model Parameters
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
Stringremote_id
StringAdditional POST Parameters
integration_params
Objectjob_merge_id
String
Supported POST Model Parameters
candidate
UUIDfile_name
Stringfile_url
Stringremote_id
String
Supported POST Model Parameters
candidate
UUIDfile_name
Stringfile_url
Stringremote_id
String
Supported POST Model Parameters
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
Stringremote_id
String
Supported POST Model Parameters
attachment_type
Enumcandidate
UUIDfile_url
Stringremote_id
String
Supported POST Model Parameters
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
Stringremote_id
Stringhttps://api.merge.dev/api/ats/v1/attachments/{id}
Returns an Attachment
object with the given id
.
expand
Stringid
UUIDinclude_remote_data
Booleanremote_fields
Stringshow_enum_origins
String
Supported Response Fields
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
string
Supported Response Fields
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Supported Response Fields
attachment_type
Enumcandidate
UUIDfile_url
Stringremote_id
String
Supported Response Fields
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
string
Supported Response Fields
candidate
UUIDfile_name
Stringfile_url
Stringremote_id
String
Supported Response Fields
attachment_type
Enumcandidate
UUIDfile_name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Supported Response Fields
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
String
Supported Response Fields
attachment_type
Enumcandidate
UUIDfile_name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Supported Response Fields
candidate
UUIDfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Supported Response Fields
file_name
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Supported Response Fields
candidate
UUIDfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Supported Response Fields
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
string
Supported Response Fields
candidate
UUIDfile_name
Stringfile_url
Stringremote_id
String
Supported Response Fields
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Supported Response Fields
attachment_type
Enumcandidate
UUIDfile_url
String
Supported Response Fields
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
Stringremote_id
String
Supported Response Fields
attachment_type
Enumcandidate
UUIDfile_name
Stringremote_data
RemoteData[]path
stringdata
string
Supported Response Fields
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
string
Supported Response Fields
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Supported Response Fields
candidate
UUIDfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Supported Response Fields
attachment_type
Enumcandidate
UUIDfile_name
Stringremote_data
RemoteData[]path
stringdata
string
Supported Response Fields
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Supported Response Fields
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Supported Response Fields
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
string
Supported Response Fields
candidate
UUIDfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Supported Response Fields
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Supported Response Fields
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Supported Response Fields
candidate
UUIDfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Supported Response Fields
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Supported Response Fields
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Supported Response Fields
candidate
UUIDfile_name
String
Supported Response Fields
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Supported Response Fields
candidate
UUIDfile_name
Stringfile_url
Stringremote_id
String
Supported Response Fields
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
string
Supported Response Fields
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
String
Supported Response Fields
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
Stringremote_data
RemoteData[]path
stringdata
stringremote_id
Stringhttps://api.merge.dev/api/ats/v1/attachments/meta/post
Returns metadata for Attachment
POSTs.

Supported POST Model Parameters
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
Stringremote_id
String
Supported POST Model Parameters
candidate
UUIDfile_name
Stringfile_url
Stringremote_id
String
Supported POST Model Parameters
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
StringAdditional POST Parameters
integration_params
Objectcompany_id
Stringposition_id
String
Supported POST Model Parameters
candidate
UUIDfile_name
Stringfile_url
Stringremote_id
String
Supported POST Model Parameters
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
Stringremote_id
StringAdditional POST Parameters
integration_params
Stringremote_user_id
String
Supported POST Model Parameters
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
Stringremote_id
StringAdditional POST Parameters
remote_user_id
String
Supported POST Model Parameters
attachment_type
Enumcandidate
UUIDfile_url
String
Supported POST Model Parameters
candidate
UUIDfile_name
Stringfile_url
Stringremote_id
StringAdditional POST Parameters
remote_user_id
String
Supported POST Model Parameters
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
Stringremote_id
String
Supported POST Model Parameters
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
Stringremote_id
String
Supported POST Model Parameters
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
String
Supported POST Model Parameters
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
Stringremote_id
StringAdditional POST Parameters
integration_params
Objectjob_merge_id
String
Supported POST Model Parameters
candidate
UUIDfile_name
Stringfile_url
Stringremote_id
String
Supported POST Model Parameters
candidate
UUIDfile_name
Stringfile_url
Stringremote_id
String
Supported POST Model Parameters
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
Stringremote_id
String
Supported POST Model Parameters
attachment_type
Enumcandidate
UUIDfile_url
Stringremote_id
String
Supported POST Model Parameters
attachment_type
Enumcandidate
UUIDfile_name
Stringfile_url
Stringremote_id
String