Skip to main content
GET
List async migration jobs for this entity

Authorizations

Authorization
string
header
required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity
via Settings > Developers > API Keys.

Path Parameters

entity_id
string<uuid>
required

Query Parameters

resource
enum<string>
Available options:
accounts,
products,
orders,
journal-entries,
vendor-bills,
ap-payments,
product-categories,
product-variants,
product-pricing-policies,
product-vendors,
product-prepackaged-presets,
customer-payments,
inventory-balances-opening-stock,
inventory-balances-set-opening-stock,
inventory-transactions,
inventory-movements,
order-tax-lines,
account-addresses,
account-contacts,
purchase-orders,
returns,
vendor-credits
status
enum<string>
Available options:
pending,
running,
completed,
failed,
partial
created_after
string<date-time>

Return jobs created after this ISO 8601 timestamp

limit
integer
default:20
Required range: 1 <= x <= 100
starting_after
string<uuid>

Cursor for pagination (job_id of last record from previous page)

Response

Paginated list of migration jobs

Paginated list of migration jobs

object
enum<string>
Available options:
list
data
object[]
has_more
boolean
next_cursor
string | null