Sign in

v1

latestOpenAPI 3.1.02026-07-261770816.7 KB
Bulk Requests

Bulk request (single)

Retrieve a single bulk request, including the per-row success and failure result files. Each call mints fresh short-lived (5 minute) S3 URLs for success_results_url and failure_results_url; re-fetch this endpoint to get new URLs once they expire. The bulk request record itself, along with its result files, is deleted at expires_at.

get/v3/bulk_requests/{bulk_action_uuid}

Response

Successful

idinteger
created_atstring date-time
updated_atstring date-time
bulk_action_uuidstring

Unique identifier for the bulk request, returned when the bulk endpoint was first called. Use this to look up the request via GET /v3/bulk_requests/{bulk_action_uuid}.

requested_by_user_idinteger

Id of the Greenhouse user the bulk request was executed on behalf of (the ISU or the access-token user).

statusstring

Current lifecycle state of the bulk request. One of building (the request is being assembled), pending (queued and waiting to start), in_progress (jobs are running), completed (every job finished, regardless of per-row success), or failed (the bulk request itself failed before its rows could run).

record_countinteger

Total number of rows submitted in the bulk request's data array.

success_countinteger

Number of rows that completed successfully so far. Updates incrementally while status is in_progress.

failure_countinteger

Number of rows that returned an error so far. Updates incrementally while status is in_progress; the per-row error bodies are written to failure_results_url on the single-bulk-request response.

callback_urlstring nullable

Webhook URL Greenhouse will POST to when the bulk request completes, as supplied at creation time. Null if no callback was requested.

callback_responsestring nullable

Status-line summary of Greenhouse's POST to callback_url (for example 200 OK). Null until the callback fires, or when no callback was requested.

completed_atstring date-time nullable

Timestamp when the bulk request reached completed or failed state, in ISO 8601. Null while the request is still active.

expires_atstring date-time nullable

Timestamp after which Greenhouse deletes this bulk request record and its result files, in ISO 8601. Null until the request finishes.

api_endpointstring

Identifier of the underlying single-resource endpoint each row in data is dispatched to (for example post_v3_openings, delete_v3_openings).

requested_atstring date-time nullable

Timestamp when the bulk request was created, in ISO 8601.

success_results_urlstring nullable

Short-lived S3 URL to a JSON file listing the per-row success responses. Only present on the single-bulk-request endpoint, and null when no rows succeeded or the request has not finished.

failure_results_urlstring nullable

Short-lived S3 URL to a JSON file listing the per-row error responses. Only present on the single-bulk-request endpoint, and null when no rows failed or the request has not finished.

results_urls_expire_instring

Human-readable lifetime of success_results_url and failure_results_url (for example 5 minutes). Re-fetch the bulk request to mint fresh URLs after they expire.

results_urls_expire_atstring date-time

Timestamp after which success_results_url and failure_results_url stop working, in ISO 8601. Re-request the bulk request to generate new URLs.