v1

latestOpenAPI 3.1.02026-07-261770816.7 KB
Users

Bulk create users

Create up to the bulk-endpoint cap of users in a single request. Pass an array of user payloads in data, each matching the body shape of POST /v3/users. Each row is processed independently and the response reports per-row success or failure; rows that fail validation do not block the others. Use for HRIS-driven backfills or for provisioning a wave of new hires.

post/v3/users/bulk

Request body

callback_urlstring

Optional HTTPS URL Greenhouse will POST to when every row in data has finished. Omit to poll GET /v3/bulk_requests/{bulk_action_uuid} instead.

Response

Accepted

bulk_action_uuidstring

UUID assigned to the new bulk request. Use this with GET /v3/bulk_requests/{bulk_action_uuid} to monitor progress and retrieve per-row results.

statusstring

Initial lifecycle state of the new bulk request, typically building immediately after creation. See the bulk request response schema for the full set of values.

status_urlstring

Relative path that returns the current status of the bulk request. Append this to your Harvest base URL to fetch the latest state.