> ## Documentation Index > Fetch the complete documentation index at: https://docs.arcuserp.com/llms.txt > Use this file to discover all available pages before exploring further. # List async migration jobs for this entity > Returns a cursor-paginated list of migration jobs scoped to the entity. Supports filtering by resource type, status, and creation timestamp. Requires migration:read scope. ## OpenAPI ````yaml /openapi.yaml get /entities/{entity_id}/migration/jobs openapi: 3.1.0 info: title: Arcus ERP Public API version: 1.0.0 description: > Arcus ERP public REST API. Designed for external integrations and data migration. **Authentication.** Bearer token (API key) via the `Authorization` header. Format: `Authorization: Bearer ark_live_ent__` (or `ark_test_*` for sandbox). API keys are issued per-entity in **Settings > Developers > API Keys**. **Entity scoping.** The entity is encoded in the API key prefix; routes are flat (e.g. `/v1/accounts`, `/v1/orders`, `/v1/products`). A small set of platform endpoints (migration, reconciliation, events, webhook endpoints, API keys) use the `/v1/entities/{entity_id}/...` form -- those are noted in their tags. **Key capabilities.** - Related-resource hydration via `?expand[]=` (see `x-arcus-expand` on each resource). - Cursor-based pagination (`starting_after` / `ending_before` / `limit`). - Idempotency via the `Idempotency-Key` header. - Webhook events for asynchronous notification. - Conditional requests / ETag for cache validation. servers: - url: https://api.arcuserp.com/v1 description: Arcus ERP API (accepts both live `ark_live_*` and test `ark_test_*` keys) - url: https://dev-api.arcuserp.com/v1 description: >- Dev sandbox API (test-only data, accepts `ark_test_*` keys against dev RDS) security: [] paths: /entities/{entity_id}/migration/jobs: get: tags: - Migration summary: List async migration jobs for this entity description: | Returns a cursor-paginated list of migration jobs scoped to the entity. Supports filtering by resource type, status, and creation timestamp. Requires migration:read scope. operationId: listMigrationJobs parameters: - name: entity_id in: path required: true schema: type: string format: uuid - name: resource in: query required: false schema: type: string enum: - 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 - name: status in: query required: false schema: type: string enum: - pending - running - completed - failed - partial - name: created_after in: query required: false schema: type: string format: date-time description: Return jobs created after this ISO 8601 timestamp - name: limit in: query required: false schema: type: integer minimum: 1 maximum: 100 default: 20 - name: starting_after in: query required: false schema: type: string format: uuid description: Cursor for pagination (job_id of last record from previous page) responses: '200': description: Paginated list of migration jobs content: application/json: schema: $ref: '#/components/schemas/MigrationJobList' '401': $ref: '#/components/responses/Error' '403': $ref: '#/components/responses/Error' security: - ApiKeyAuth: [] components: schemas: MigrationJobList: type: object description: Paginated list of migration jobs properties: object: type: string enum: - list data: type: array items: $ref: '#/components/schemas/MigrationJob' has_more: type: boolean next_cursor: type: string nullable: true MigrationJob: type: object description: Async bulk import job status record properties: id: type: string format: uuid object: type: string enum: - migration_job entity_id: type: string format: uuid resource: type: string description: >- Resource type (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: type: string enum: - pending - running - completed - failed - partial dry_run: type: boolean conflict_mode: $ref: '#/components/schemas/MigrationConflictMode' external_source: type: string description: Source system identifier (e.g. "versa", "shopify", "quickbooks") total_records: type: integer processed_records: type: integer succeeded_records: type: integer failed_records: type: integer errors: type: array items: type: object properties: index: type: integer external_id: type: string error: type: string code: type: string started_at: type: string format: date-time nullable: true completed_at: type: string format: date-time nullable: true created_at: type: string format: date-time ErrorEnvelope: type: object description: | Canonical error response envelope. All API errors use this shape. required: - error - code properties: error: type: string description: Machine-readable error key example: not_found code: type: string description: Machine-readable error code (often same as error) example: not_found type: type: string enum: - validation_error - permission_error - not_found - conflict - rate_limit - internal - expand_error - not_implemented example: not_found hint: type: string description: Human-readable one-sentence explanation (English) example: >- The requested order does not exist or does not belong to this entity. param: type: string description: The parameter that caused the error, if applicable example: expand[0] required: type: string description: The scope required (only on insufficient_scope errors) example: accounts:read request_id: type: string description: >- Unique request ID for support tracing (maps to CloudWatch log stream) example: req_abc123 MigrationConflictMode: type: string enum: - skip - update - replace - error default: skip description: > How to handle a record whose (external_source, external_id) already exists in Arcus. - skip: leave the existing record unchanged, count as success - update: call the canonical UPDATE handler with the incoming payload - replace: NULL out the existing record's provenance UNIQUE, then INSERT new record - error: abort the entire batch on the first collision (default if not specified: skip) responses: Error: description: Error response (400/401/403/404/409/422/429/500) content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' securitySchemes: ApiKeyAuth: type: http scheme: bearer description: | 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. ````