Migrate Documents Status

POST /v2/organizations/documents/migrate/status

Migrate Documents Status

cURL

curl --request POST \
  --url https://api.velt.dev/v2/organizations/documents/migrate/status \
  --header 'Content-Type: application/json' \
  --header 'x-velt-api-key: <x-velt-api-key>' \
  --header 'x-velt-auth-token: <x-velt-auth-token>' \
  --data '
{
  "data": {
    "organizationId": "<string>",
    "migrationId": "<string>"
  }
}
'

{
  "result": {
    "status": "success",
    "message": "Migration status retrieved successfully.",
    "data": {
      "migrationId": "yourMigrationId",
      "status": "completed"
    }
  }
}

Use this API to poll the status of a document migration. Use the migrationId returned from the Migrate Documents endpoint.

Endpoint

POST https://api.velt.dev/v2/organizations/documents/migrate/status

Headers

x-velt-api-key · string · required

Your API key.

x-velt-auth-token · string · required

Your Auth Token.

Body

Params

data · object · required

Show properties

organizationId · string · required

Organization ID

migrationId · string · required

Migration ID returned from the Migrate Documents endpoint

Example Requests

Check migration status

{
  "data": {
    "organizationId": "yourOrganizationId",
    "migrationId": "yourMigrationId"
  }
}

Response

Success Response

The status field reflects the current state of the migration. Possible values: pending, in_progress, completed, failed.

{
  "result": {
    "status": "success",
    "message": "Migration status retrieved successfully.",
    "data": {
      "migrationId": "yourMigrationId",
      "status": "completed"
    }
  }
}

Failure Response

{
  "error": {
    "message": "ERROR_MESSAGE",
    "status": "INVALID_ARGUMENT"
  }
}

{
  "result": {
    "status": "success",
    "message": "Migration status retrieved successfully.",
    "data": {
      "migrationId": "yourMigrationId",
      "status": "completed"
    }
  }
}