Skip to navigation
API ReferenceBulk SyncExecutions

Export Sync Logs

Starts an asynchronous job that packages the log files for a single bulk sync execution into a downloadable archive.

📘 Log export is asynchronous

This endpoint starts a background job that packages an execution’s log files into a downloadable archive. The first call typically returns a job descriptor instead of a completed result. Poll GET /api/jobs/exportlogs/{id} with the returned job_id until status is done; the final response contains a signed url that can be used to download the archive.

Set notify=true to also email the requesting user when the archive is ready.

Authentication

AuthorizationBearer
Bearer user API key
OR
AuthorizationBasic

Basic organization-scoped API key

Path parameters

sync_idstringRequiredformat: "uuid"
Unique identifier of the bulk sync
execution_idstringRequiredformat: "uuid"
Unique identifier of the execution whose logs should be exported

Headers

X-Polytomic-VersionstringOptional

Query parameters

notifybooleanOptional
Send a notification to the user when the logs are ready for download.

Response

OK
dataobjectOptional
The exported log archive, with an empty url while the export job runs
jobobjectOptional
Export job to poll, present while the log archive is being prepared

Errors

400
Bad Request Error
404
Not Found Error
500
Internal Server Error