PDFs
Get PDF jobs
Read PDF job status and obtain completed downloads.
/api/v1/pdfs/print_jobs/get_many- Authentication
- OAuth 2.0 access token
- Required scopes
recipients.readforms.readdocuments.readtax_ids.read- Idempotency key
- Not required
- Rate-limit cost
- 5 units
How to use this endpoint
Send up to 100 job IDs. Results keep request order and identify missing IDs. include_download_urls defaults to true; links are returned only for completed artifacts. Treat download URLs as confidential.
Request example
curl --request POST 'https://api.efilemagic.com/api/v1/pdfs/print_jobs/get_many' \
--header 'Authorization: Bearer <access-token>' \
--header 'Content-Type: application/json' \
--data '{"job_ids":["11111111-1111-4111-8111-111111111111"]}'Replace placeholders with your own values. Use the API resource origin provided for your environment.
Request fields
2 fieldsjob_idsRequiredarray<string (uuid)>
PDF job identifiers. For scheduled output, use the export_id returned by the print request. Minimum items: 1. Maximum items: 100.
include_download_urlsOptionalboolean
Include short-lived download links for completed PDF artifacts. Default: true.
Headers (1)
AuthorizationRequired- OAuth Bearer token with the listed scopes and current resource authorization.
Complete request schema: GetManyScheduledPdfPrintJobsRequest
Request example
curl --request POST 'https://api.efilemagic.com/api/v1/pdfs/print_jobs/get_many' \
--header 'Authorization: Bearer <access-token>' \
--header 'Content-Type: application/json' \
--data '{"job_ids":["11111111-1111-4111-8111-111111111111"]}'Replace placeholders with your own values. Use the API resource origin provided for your environment.
On success, data contains the fields below. meta includes api_version and request_id. Keep request_id when reporting a problem.
Response fields
2 fieldsitemsAlways returnedarray<object>
Type: array<object>.
Nested fields (9)
delivery_kindAlways returnedstring | null
Allowed values: "pdf", "zip", "manifest", null.
download_urlAlways returnedstring | null (uri)
Type: string | null (uri).
export_idAlways returnedstring (uuid)
Type: string (uuid).
filer_idAlways returnedstring (uuid)
Type: string (uuid).
form_idAlways returnedstring | null
Type: string | null.
job_idAlways returnedstring (uuid)
Type: string (uuid).
recipient_form_countAlways returnedinteger
Type: integer.
statusAlways returnedstring | null
Allowed values: "queued", "processing", "merging", "completed", "failed".
tax_yearAlways returnedinteger
Allowed values: 2022, 2023, 2024, 2025, 2026.
missingAlways returnedarray<string (uuid)>
Type: array<string (uuid)>.
{
"data": {
"items": "array<object>",
"missing": "array<string (uuid)>"
},
"meta": {
"api_version": "v1",
"request_id": "string"
}
}Successful response structure. This outline shows field types, not a response to copy. Expand Response fields for nested properties and optional values.
Errors to handle
Errors use {error: {code, message}, meta}. Check the code and message before retrying. Authentication, validation and availability errors can occur before the operation runs.
- 400
invalid_request - Check required fields, selectors and supported values.
- 401
invalid_token - Obtain a valid OAuth token for this resource. Check its expiry and current authorization.
- 403
insufficient_scope - Request the listed scopes through the application's authorization flow.
- 403
forbidden - Check the connection's permissions and allowed filers. More scopes alone may not grant access.
- 404
not_found - Check the resource ID and its owning filer. Batch reads report missing IDs as documented.
- 422
validation_failed - Correct the reported validation issues before retrying.
- 429
rate_limited - Wait for Retry-After before retrying. Avoid concurrent retries.
- 500
internal_error - Retain request_id; retry with bounded backoff.
- 503
service_unavailable - Retry with bounded backoff.