Attachments

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

The Attachment object

Properties


idString
Optional

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

The Attachment 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"
      ]
    }
  ]
}

GET

/attachments

Returns a list of Attachment objects.


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.

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_idString
Optional
The API provider's ID for the given object.

Response

{
  "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"
          ]
        }
      ]
    }
  ]
}
Field support by platform

Greenhouse

Greenhouse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


attachment_typeEnum

candidateString

file_nameString

file_urlString

Recruiterflow

Recruiterflow

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

candidateString

file_nameString

file_urlString

remote_idString

Recruitee

Recruitee

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

attachment_typeEnum

candidateString

file_nameString

file_urlString

remote_idString

Homerun

Homerun

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


candidateString

file_nameString

file_urlString

remote_idString

Oracle Taleo

Oracle Taleo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


attachment_typeEnum

candidateString

file_nameString

file_urlString

remote_idString

Workable

Workable

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

attachment_typeEnum

candidateString

file_urlString

Teamtailor

Teamtailor

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

candidateString

file_nameString

file_urlString

remote_idString

TalentLyft

TalentLyft

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

candidateString

file_nameString

file_urlString

SmartRecruiters

SmartRecruiters

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

attachment_typeEnum

candidateString

file_nameString

file_urlString

remote_idString

ApplicantStack

ApplicantStack

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

attachment_typeEnum

candidateString

file_nameString

file_urlString

HR Cloud

HR Cloud

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

attachment_typeEnum

candidateString

file_nameString

file_urlString

remote_idString

Jobvite

Jobvite

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

attachment_typeEnum

candidateString

file_nameString

Fountain

Fountain

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

candidateString

file_nameString

remote_idString

Breezy HR

Breezy HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

attachment_typeEnum

candidateString

file_nameString

file_urlString
POST

/attachments

BETA

Creates an Attachment object with the given values.


Query & Path Parameters


remote_user_idString
Optional
The ID of the RemoteUser modifying the resource. This can be found in the ID field (not remote_id) in the RemoteUser table.

run_asyncBoolean
Optional
Whether or not third-party updates should be run asynchronously.

Body 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.

Response

{
  "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"
      ]
    }
  ]
}
Field support by platform

Greenhouse

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

Recruitee

Recruitee

Merge supports Passthrough Requests to this platform's API

Supported POST Query & Path Parameters


remote_user_idString
Optional

Supported POST Body Parameters


file_nameString
Optional

remote_idString
Optional

candidateString
Required

file_urlString
Required

Ashby

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_nameString
Optional

file_urlString
Required

remote_idString
Optional

Lever

Lever

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
Optional

file_urlString
Required

remote_idString
Optional
GET

/attachments/{id}

Returns an Attachment object with the given id.


Query & Path Parameters


idString
Required

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.

Response

{
  "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"
      ]
    }
  ]
}
Field support by platform

Greenhouse

Greenhouse

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


attachment_typeEnum

candidateString

file_nameString

file_urlString

Recruiterflow

Recruiterflow

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

candidateString

file_nameString

file_urlString

remote_idString

Recruitee

Recruitee

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

attachment_typeEnum

candidateString

file_nameString

file_urlString

remote_idString

Homerun

Homerun

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


candidateString

file_nameString

file_urlString

remote_idString

Oracle Taleo

Oracle Taleo

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


attachment_typeEnum

candidateString

file_nameString

file_urlString

remote_idString

Workable

Workable

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

attachment_typeEnum

candidateString

file_urlString

Teamtailor

Teamtailor

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

candidateString

file_nameString

file_urlString

remote_idString

TalentLyft

TalentLyft

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

candidateString

file_nameString

file_urlString

SmartRecruiters

SmartRecruiters

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

attachment_typeEnum

candidateString

file_nameString

file_urlString

remote_idString

ApplicantStack

ApplicantStack

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

attachment_typeEnum

candidateString

file_nameString

file_urlString

HR Cloud

HR Cloud

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

attachment_typeEnum

candidateString

file_nameString

file_urlString

remote_idString

Jobvite

Jobvite

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

attachment_typeEnum

candidateString

file_nameString

Fountain

Fountain

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

candidateString

file_nameString

remote_idString

Breezy HR

Breezy HR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


remote_dataRemoteData[]

attachment_typeEnum

candidateString

file_nameString

file_urlString