Downloads a candidate's completed preconfigured documents as a single zip archive.
Preconfigured documents are the document templates your team has set up in Apploi. This endpoint returns the individual files pulled out of those documents once the candidate has completed them, bundled into one archive and served as an attachment named files.zip.
Which templates are covered, and which files are extracted from each, is part of your team's document configuration in Apploi rather than something you select per request. A team with no such configuration set up — and no parent team configuration to fall back on — gets a 404 from this endpoint rather than an empty archive.
Only documents the candidate has actually completed are included. An application whose documents are still outstanding also returns a 404, so a 404 here does not necessarily mean the application does not exist. A 200 is not a guarantee of content either: when the candidate has completed documents but none of the files configured for them are found, the archive comes back empty.
Access is authorized per candidate: the caller must have permission on the job the candidate applied to, otherwise the request is rejected with a 403.
Every request to this endpoint must include your Apploi-issued API key in the x-api-key header.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
The request was rejected before the archive could be assembled, either because the caller has no permission on the job this candidate applied to or because the API key's user lacks the file-download permission. The body depends on where the rejection happened: a missing or unrecognized x-api-key header is rejected by the API gateway itself, which returns {"message": "Forbidden"}, while a rejection further in returns {"developer_message": ...}.
Returned for four distinct reasons:
- No application exists with the given
applicant_id. - The
applicant_idin the path was not an integer. - Your team, and its parent team, have no document configuration set up for this endpoint. This is the only one of the four with a
developer_messagethat identifies it:Endpoint not configured for this team. - The candidate has no completed documents to return.
The developer_message does not reliably tell the other three apart, so do not branch on it. The last two reasons mean the application exists and is readable but has nothing to download, so treat a 404 here as an empty result rather than as a missing application.
The archive could not be assembled because of an error on Apploi's side. The request can safely be retried. Note that any document already read before the error is recorded as downloaded in the candidate's activity log, so a failed request and its retry can each leave entries behind.