v1Resources/Locations/getRead migration progress

Read migration progress

Requires an owner/admin with agency-wide credentials. Only the initiating user can read the job. Status and moved, failed and skipped counts distinguish accepted work from completed work; failedItems includes location names and failure reasons.

get/api/v1/locations/migrate-jobs/{id}
locations:read
Query parameters
idstringrequired
Job ID returned by the migration start operation.
Response
dataobjectoptional
idstringoptional
statusstringoptional
totalintegeroptional
movedintegeroptional
failedintegeroptional
skippedintegeroptional
toClientIdstringoptional
failedItemsarray of objectoptional
locationIdstringoptional
namestringoptional
reasonstringoptional
Errors
400The request is missing a required parameter or is otherwise malformed.
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
409Content checks held the action, or the migration preview is stale or changed.
422The location operation needs attention or could not be completed.
429Too many requests. Retry after the number of seconds in the Retry-After header.
503The location operation needs attention or could not be completed.
get/api/v1/locations/migrate-jobs/{id}
Your API key
id *
{}

Guides that use this resource