Skip to main content
GET
/
entities
/
{entity_id}
/
migration
/
jobs
List async migration jobs for this entity
curl --request GET \
  --url https://api.arcuserp.com/v1/entities/{entity_id}/migration/jobs \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "object": "migration_job",
      "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "resource": "<string>",
      "status": "pending",
      "dry_run": true,
      "conflict_mode": "skip",
      "external_source": "<string>",
      "total_records": 123,
      "processed_records": 123,
      "succeeded_records": 123,
      "failed_records": 123,
      "errors": [
        {
          "index": 123,
          "external_id": "<string>",
          "error": "<string>",
          "code": "<string>"
        }
      ],
      "started_at": "2023-11-07T05:31:56Z",
      "completed_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "has_more": true,
  "next_cursor": "<string>"
}

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.

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
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