Batch

Get batch details

Changed on

Fetch the details, status, and progress of a specific batch

get/v2/batch/{id}

Request

  • Base URL
    https://api.sync.so
  • Auth
    API key in header x-api-key

Path parameters

idstring required

Batch ID

Response

Batch details retrieved successfully

idstring
created_atstring date-time
status'PENDING' | 'JOBS_CREATED' | 'PROCESSING' | 'COMPLETED' | 'FAILED'
webhookUrlstring uri nullable
outputUrlstring

Changes

    • breaking

      response property webhookUrl list-of-types was widened by adding types null to media type application/json of response 200