Sign in

v1

latestOpenAPI 3.1.02026-07-261770816.7 KB
Attachments

List attachments

Attachments are files associated with an application — resumes, cover letters, take-home tests, offer documents, e-signed agreements, and other supporting documents. Each attachment belongs to one application; filter by application_ids or candidate_ids to scope results to a specific pipeline. The url returned for each attachment is a time-limited download link that expires after seven days, so refetch the attachment whenever you need a fresh URL.

get/v3/attachments

Query parameters

cursorstring

Cursor link for pagination from previous page response header. Do not use any other parameters when using this.

per_pageinteger

Number of results per page

idsinteger[]

Comma separated list

gtestring date-time
ltestring date-time
gtstring date-time
ltstring date-time
gtestring date-time
ltestring date-time
gtstring date-time
ltstring date-time
application_idsinteger[]

Comma separated list

candidate_idsinteger[]

Return only attachments whose application belongs to one of these candidates (people).

fieldsstring[]

Comma separated list of fields to return

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

Filter by attachment type. resume, cover_letter, take_home_test are candidate-supplied documents; offer_packet, offer_letter, signed_offer_letter are offer documents; midfunnel_agreement and automated_agreement are e-signed documents; form_attachment is generated by Greenhouse forms; other is the free-form bucket.

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. Links expire after seven days; refetch the attachment to obtain a fresh URL.