Data Migrations

get

Authorizations

APIKey

AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

Query parameters

limitinteger · int32 · min: 1 · max: 100Optional

The maximum number of items to return in a single request.

afterstring · flake-idOptional

Returns items after the specified ID. Used for forward pagination through results.

Example: 411486491630370816

beforestring · flake-idOptional

Returns items before the specified ID. Used for backward pagination through results.

Example: 411486491630370816

ascbooleanOptional

Determines the sort order of returned items. When true, items are returned in ascending order. When false, items are returned in descending order.

Responses

200

OK

application/json

idstring · flake-idRequiredExample: 411486491630370816

store_idstring · flake-idRequiredExample: 411486491630370816

platformstringRequired

Platform from which data is being migrated (e.g., "tebex").

tokenstringRequired

Masked authentication token used for accessing the source platform API.

errorstring · nullableOptional

Error message if the migration encountered any errors, otherwise null.

started_atstring · date-timeRequired

Timestamp when the migration was initiated.

failed_atstring · nullableOptional

Timestamp when the migration failed, or null if it didn't fail.

completed_atstring · nullableOptional

Timestamp when the migration was successfully completed, or null if not completed.

total_entities_to_migrateinteger · nullableOptional

Total number of entities that need to be migrated, or null if unknown.

total_entities_migratedinteger · int32Required

Number of entities that have been successfully migrated.

default

Error response

application/json

get

/v1/stores/{storeId}/data-migrations

HTTPcURLJavaScriptPython

GET /v1/stores/{storeId}/data-migrations HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "id": "411486491630370816",
    "store_id": "411486491630370816",
    "platform": "text",
    "token": "text",
    "error": null,
    "started_at": "2026-02-19T00:01:06.211Z",
    "failed_at": null,
    "completed_at": null,
    "total_entities_to_migrate": null,
    "total_entities_migrated": 1,
    "started_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    }
  }
]

post

Authorizations

APIKey

AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters

storeIdstring · flake-idRequiredExample: 411486491630370816

Body

application/jsontext/jsonapplication/*+json

headless_tokenstringRequired

The public-facing Headless API token.

plugin_tokenstringRequired

An API token associated to a Tebex game server.

Responses

200

OK

application/json

idstring · flake-idRequiredExample: 411486491630370816

store_idstring · flake-idRequiredExample: 411486491630370816

platformstringRequired

Platform from which data is being migrated (e.g., "tebex").

tokenstringRequired

Masked authentication token used for accessing the source platform API.

errorstring · nullableOptional

Error message if the migration encountered any errors, otherwise null.

started_atstring · date-timeRequired

Timestamp when the migration was initiated.

failed_atstring · nullableOptional

Timestamp when the migration failed, or null if it didn't fail.

completed_atstring · nullableOptional

Timestamp when the migration was successfully completed, or null if not completed.

total_entities_to_migrateinteger · nullableOptional

Total number of entities that need to be migrated, or null if unknown.

total_entities_migratedinteger · int32Required

Number of entities that have been successfully migrated.

default

Error response

application/json

post

/v1/stores/{storeId}/data-migrations/tebex

HTTPcURLJavaScriptPython

POST /v1/stores/{storeId}/data-migrations/tebex HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "headless_token": "text",
  "plugin_token": "text"
}

application/jsontext/jsonapplication/*+json

[
  {
    "id": "411486491630370816",
    "store_id": "411486491630370816",
    "platform": "text",
    "token": "text",
    "error": null,
    "started_at": "2026-02-19T00:01:06.211Z",
    "failed_at": null,
    "completed_at": null,
    "total_entities_to_migrate": null,
    "total_entities_migrated": 1,
    "started_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    }
  }
]