v1

latestOpenAPI 3.1.02026-07-243113441.2 MB

People Batches

Get a people batch

Returns the status and results of a people batch.

Poll this endpoint to check the batch processing status and retrieve results.

scope: people_batches:read

get/v1/people_batches/{people_batch_uuid}

people_batch_uuidstring required

The UUID of the people batch

X-Gusto-API-Version'2026-06-15'

Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used.

successful

uuidstring uuid required

The unique identifier of the people batch.

idempotency_keystring uuid required

The idempotency key provided when creating the batch.

status'pending' | 'processing' | 'completed' | 'failed' | 'partial_success' required

The current status of the batch processing.

submitted_atstring date-time

The timestamp when the batch was submitted.

completed_atstring date-time nullable

The timestamp when the batch processing completed.

submitted_itemsinteger nullable

The number of items submitted in the batch.

processed_itemsinteger

The number of items successfully processed.

excluded_itemsinteger

The number of items excluded from processing.