Skip to content
calternal docs

Report legacy account migration

GET
/api/v1/system/integrations/legacy-migration
curl --request GET \
  --url https://example.com/api/v1/system/integrations/legacy-migration \
  --header 'Authorization: Bearer <token>'

Return the latest migration state and safe error codes for legacy accounts that did not move to Connected Accounts. A signed-in User with data scope is required. Requests can return 401 if the session is missing or 403 if the User lacks data scope. Route: /api/v1/system/integrations/legacy-migration. Inputs: . Safe reads can use bounded retries.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json

Safe Settings view of migration state, with User-scoped IDs and no secret data (#407, DESIGN §49 I6).

object
error_code
One of:

Safe reasons why a legacy account could not link to a shared account (#407, DESIGN §49 I6).

string
Allowed values: database credential account_conflict
failed_accounts
required
Array<object>

User-scoped migration failure with stable cache identity and a safe code only (§49 I6, #407).

object
account_id
required
string
error_code
required

Safe reasons why a legacy account could not link to a shared account (#407, DESIGN §49 I6).

string
Allowed values: database credential account_conflict
service
required
string
state
required

Observable result of legacy account reconciliation (#407, DESIGN §49 I6).

string
Allowed values: pending complete failed
Example
{
  "error_code": "database",
  "failed_accounts": [
    {
      "error_code": "database"
    }
  ],
  "state": "pending"
}

401

Section titled “401”
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}

403

Section titled “403”
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}