Sign in

v1

latestOpenAPI 3.1.02026-07-261770816.7 KB
Bulk Requests

Bulk requests

Bulk requests track the asynchronous bulk operations submitted to Harvest V3. Each time a partner hits a /v3/<resource>/bulk endpoint, Greenhouse creates a bulk request, returns its bulk_action_uuid, and dispatches each row in the data array to the matching single-resource endpoint in its own Sidekiq job. Use this endpoint to enumerate in-flight or recently completed bulk jobs for the calling client; use the single-bulk-request endpoint to retrieve per-row success and failure result files.

get/v3/bulk_requests

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
fieldsstring[]

Comma separated list of fields to return

bulk_action_uuidstring

Return only the bulk request with this UUID. Equivalent to hitting GET /v3/bulk_requests/{bulk_action_uuid} but useful when you want the list-endpoint response shape.

activeboolean

When true, return only bulk requests that are still running (building, pending, or in_progress). When false, return only finished requests (completed or failed). Omit to include every status.

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.