Sign in

v1

latestOpenAPI 3.0.12026-07-245752052.0 MB
Applicants

Request an async PDF print of an applicant

Enqueues a background job to generate a PDF of the applicant and returns a pollable download URL. The PDF is generated asynchronously; clients should poll the returned print_url until it returns 200. Optionally restrict the PDF to specific stages via stage_external_ids; when omitted, every stage the applicant has landed in is included.

post/api/v2/applicants/{applicant_id}/print

Request body

stage_external_idsstring[]

External IDs of the stages to include in the PDF. Defaults to all landed stages when omitted.

Response

Print request accepted and job enqueued

request_idstring required

Opaque identifier for polling the print request

print_urlstring uri required

URL clients should poll for the PDF

status'pending' | 'completed' | 'failed' required

Current status of the request

created_atstring date-time required

When the request was created