GRgreenhouse
Attachments

Create attachment

Attach a file to an existing application. Supply the bytes inline as base64-encoded content, or point Greenhouse at a publicly fetchable url and we will download the file on your behalf — exactly one of the two is required. type controls how the attachment is classified in Greenhouse (resume, cover_letter, offer_letter, etc.); uploading a resume or cover_letter replaces any prior attachment of that type by reclassifying the existing one as other. Filenames are validated against the organization's blocklisted-extensions list (for example, .html is rejected for take_home_test).

post/v3/attachments

Request

  • Base URL
    https://harvest.greenhouse.io
  • URL
    https://harvest.greenhouse.io/v3/attachments
  • Auth
    • OAuth 2
      Authorization code: https://auth.greenhouse.io/authorize
      Client credentials
      Token URL: https://auth.greenhouse.io/token scopes: harvest:attachments:create
    • or HTTP bearer

Request body

OR

Response

Successful

idinteger
created_atstring date-time
updated_atstring date-time
application_idinteger

Id of the application this attachment is associated with.

candidate_idinteger nullable

Id of the candidate (person) the attachment ultimately belongs to, resolved through the application. null if the application's candidate cannot be resolved.

type'resume' | 'cover_letter' | 'take_home_test' | 'offer_packet' | 'offer_letter' | 'signed_offer_letter' | 'other' | 'form_attachment' | 'midfunnel_agreement' | 'automated_agreement'

Classification of the attachment. resume, cover_letter, and take_home_test are candidate-supplied documents; offer_packet, offer_letter, and signed_offer_letter are offer documents; midfunnel_agreement and automated_agreement are e-signed documents; form_attachment is generated by Greenhouse forms; other is a free-form bucket for any document that doesn't fit the above.

filenamestring

Original filename of the uploaded document, including extension.

urlstring

Time-limited download URL for the underlying file. The link may be served via a Greenhouse redirect endpoint that issues a fresh short-lived file URL on each request — HTTP clients should follow redirects when downloading. Links expire after seven days; refetch the attachment to obtain a fresh URL.

Changes