Attachments

The Attachment object is used to represent a attachment for a candidate.

The Attachment object

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, or - in cases where there is no clear mapping - the original value passed through.

remote_dataRemoteData[]

Optional

remote_was_deletedBoolean

Required

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_data": [
    {
      "path": "/attachments",
      "data": [
        "Varies by platform"
      ]
    }
  ],
  "remote_was_deleted": true
}

GET

/attachments

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, will only return objects modified after this datetime.

modified_beforeString

Optional

If provided, will only return objects modified before this datetime.

page_sizeInteger

Optional

Number of results to return per page.

remote_fieldsString

Optional

Which fields should be returned in non-normalized form.

remote_idString

Optional

The API provider's ID for the given object.

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_data": [
        {
          "path": "/attachments",
          "data": [
            "Varies by platform"
          ]
        }
      ],
      "remote_was_deleted": true
    }
  ]
}

Field support by platform

ApplicantStack

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum

candidateString

file_nameString

file_urlString

remote_dataRemoteData[]

Breezy

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum

candidateString

file_nameString

file_urlString

remote_dataRemoteData[]

CATS

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum

candidateString

file_nameString

remote_dataRemoteData[]

remote_idString

Comeet

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum

candidateString

file_nameString

file_urlString

Cornerstone TalentLink

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum

candidateString

file_nameString

remote_dataRemoteData[]

remote_idString

Fountain

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

candidateString

file_nameString

file_urlString

remote_dataRemoteData[]

remote_idString

Greenhouse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum

candidateString

file_nameString

file_urlString

remote_dataRemoteData[]

Homerun

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

candidateString

file_nameString

file_urlString

remote_idString

HR Cloud

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum

candidateString

file_nameString

file_urlString

remote_dataRemoteData[]

remote_idString

JazzHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

candidateString

file_nameString

file_urlString

remote_idString

JobScore

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum

candidateString

file_nameString

remote_dataRemoteData[]

remote_idString

Jobvite

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum

candidateString

file_nameString

remote_dataRemoteData[]

Lever

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum

candidateString

file_nameString

file_urlString

remote_dataRemoteData[]

remote_idString

Oracle Taleo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum

candidateString

file_nameString

file_urlString

remote_idString

Recruitee

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum

candidateString

file_nameString

file_urlString

remote_dataRemoteData[]

remote_idString

Recruiterflow

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

candidateString

file_nameString

file_urlString

remote_dataRemoteData[]

remote_idString

SmartRecruiters

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum

candidateString

file_nameString

file_urlString

remote_dataRemoteData[]

remote_idString

Teamtailor

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

candidateString

file_nameString

file_urlString

remote_dataRemoteData[]

remote_idString

Workable

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum

candidateString

file_urlString

remote_dataRemoteData[]

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

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

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

Must pass in a valid Merge ID, which can be obtained from the id field in the Candidate table.

attachment_typeEnum

Optional

The attachment's type. Must pass in one of the following choices: RESUME, COVER_LETTER, OFFER_LETTER, OTHER.

integration_paramsObject

Optional

linked_account_paramsObject

Optional

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_data": [
      {
        "path": "/attachments",
        "data": [
          "Varies by platform"
        ]
      }
    ],
    "remote_was_deleted": true
  },
  "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
      }
    }
  ]
}

Field support by platform

Ashby

Merge supports Passthrough Requests to this platform's API

Supported POST Query & Path Parameters

remote_user_idString

Optional

Supported POST Body Parameters

attachment_typeEnum

Optional

candidateString

Required

file_urlString

Required

Greenhouse

Merge supports Passthrough Requests to this platform's API

Supported POST Query & Path Parameters

remote_user_idString

Required

Supported POST Body Parameters

attachment_typeEnum

Optional

candidateString

Required

file_nameString

Required

file_urlString

Required

remote_idString

Optional

Additional POST Parameters

remote_user_idString

Required

Lever

Merge supports Passthrough Requests to this platform's API

Supported POST Query & Path Parameters

remote_user_idString

Required

Supported POST Body Parameters

candidateString

Required

file_nameString

Optional

file_urlString

Required

remote_idString

Optional

Additional POST Parameters

remote_user_idString

Required

Oracle Taleo

Merge supports Passthrough Requests to this platform's API

Supported POST Query & Path Parameters

remote_user_idString

Optional

Supported POST Body Parameters

attachment_typeEnum

Optional

candidateString

Optional

file_nameString

Optional

file_urlString

Optional

remote_idString

Optional

Recruitee

Merge supports Passthrough Requests to this platform's API

Supported POST Query & Path Parameters

remote_user_idString

Optional

Supported POST Body Parameters

candidateString

Required

file_nameString

Optional

file_urlString

Required

remote_idString

Optional

Teamtailor

Merge supports Passthrough Requests to this platform's API

Supported POST Query & Path Parameters

remote_user_idString

Optional

Supported POST Body Parameters

candidateString

Required

file_nameString

Optional

file_urlString

Required

remote_idString

Optional

UKG Pro Recruiting

Merge supports Passthrough Requests to this platform's API

Supported POST Query & Path Parameters

remote_user_idString

Optional

Supported POST Body Parameters

attachment_typeEnum

Optional

candidateString

Optional

file_nameString

Optional

file_urlString

Optional

remote_idString

Optional

Workable

Merge supports Passthrough Requests to this platform's API

Supported POST Query & Path Parameters

remote_user_idString

Optional

Supported POST Body 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}

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

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_data": [
    {
      "path": "/attachments",
      "data": [
        "Varies by platform"
      ]
    }
  ],
  "remote_was_deleted": true
}

Field support by platform

ApplicantStack

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum

candidateString

file_nameString

file_urlString

remote_dataRemoteData[]

Breezy

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum

candidateString

file_nameString

file_urlString

remote_dataRemoteData[]

CATS

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum

candidateString

file_nameString

remote_dataRemoteData[]

remote_idString

Comeet

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum

candidateString

file_nameString

file_urlString

Cornerstone TalentLink

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum

candidateString

file_nameString

remote_dataRemoteData[]

remote_idString

Fountain

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

candidateString

file_nameString

file_urlString

remote_dataRemoteData[]

remote_idString

Greenhouse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum

candidateString

file_nameString

file_urlString

remote_dataRemoteData[]

Homerun

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

candidateString

file_nameString

file_urlString

remote_idString

HR Cloud

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum

candidateString

file_nameString

file_urlString

remote_dataRemoteData[]

remote_idString

JazzHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

candidateString

file_nameString

file_urlString

remote_idString

JobScore

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum

candidateString

file_nameString

remote_dataRemoteData[]

remote_idString

Jobvite

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum

candidateString

file_nameString

remote_dataRemoteData[]

Lever

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum

candidateString

file_nameString

file_urlString

remote_dataRemoteData[]

remote_idString

Oracle Taleo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum

candidateString

file_nameString

file_urlString

remote_idString

Recruitee

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum

candidateString

file_nameString

file_urlString

remote_dataRemoteData[]

remote_idString

Recruiterflow

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

candidateString

file_nameString

file_urlString

remote_dataRemoteData[]

remote_idString

SmartRecruiters

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum

candidateString

file_nameString

file_urlString

remote_dataRemoteData[]

remote_idString

Teamtailor

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

candidateString

file_nameString

file_urlString

remote_dataRemoteData[]

remote_idString

Workable

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum

candidateString

file_urlString

remote_dataRemoteData[]

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

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": {},
  "status": {
    "linked_account_status": "string",
    "can_make_request": true
  },
  "has_conditional_params": true,
  "has_required_linked_account_params": true
}

Field support by platform

ApplicantStack

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum

candidateString

file_nameString

file_urlString

remote_dataRemoteData[]

Breezy

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum

candidateString

file_nameString

file_urlString

remote_dataRemoteData[]

CATS

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum

candidateString

file_nameString

remote_dataRemoteData[]

remote_idString

Comeet

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum

candidateString

file_nameString

file_urlString

Cornerstone TalentLink

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum

candidateString

file_nameString

remote_dataRemoteData[]

remote_idString

Fountain

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

candidateString

file_nameString

file_urlString

remote_dataRemoteData[]

remote_idString

Greenhouse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum

candidateString

file_nameString

file_urlString

remote_dataRemoteData[]

Homerun

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

candidateString

file_nameString

file_urlString

remote_idString

HR Cloud

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum

candidateString

file_nameString

file_urlString

remote_dataRemoteData[]

remote_idString

JazzHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

candidateString

file_nameString

file_urlString

remote_idString

JobScore

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum

candidateString

file_nameString

remote_dataRemoteData[]

remote_idString

Jobvite

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum

candidateString

file_nameString

remote_dataRemoteData[]

Lever

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum

candidateString

file_nameString

file_urlString

remote_dataRemoteData[]

remote_idString

Oracle Taleo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum

candidateString

file_nameString

file_urlString

remote_idString

Recruitee

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum

candidateString

file_nameString

file_urlString

remote_dataRemoteData[]

remote_idString

Recruiterflow

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

candidateString

file_nameString

file_urlString

remote_dataRemoteData[]

remote_idString

SmartRecruiters

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum

candidateString

file_nameString

file_urlString

remote_dataRemoteData[]

remote_idString

Teamtailor

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

candidateString

file_nameString

file_urlString

remote_dataRemoteData[]

remote_idString

Workable

Merge supports Passthrough Requests to this platform's API

Supported Response Fields

attachment_typeEnum

candidateString

file_urlString

remote_dataRemoteData[]

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.

Applications

Next Up

Candidates