Get sync job status

Retrieves the current status and progress of a sync job

GET/v1/apps/{app_id}/integrations/{integration_id}/sync/{sync_id}

API: Integrations
OpenAPI: integrations-api
Updated: Apr 26, 2026

integrations-api:GET:/v1/apps/{app_id}/integrations/{integration_id}/sync/{sync_id}

Retrieves the current status and progress of a sync job

API ownership

API family: Integrations API
Best for: Integration records, setup verification, app and integration stats, and sync job operations.
Do not use from: Direct catalog, media, order, identity, or storefront reads and writes.
Guide route: /integrations

The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation.

Operation

Method: GET
Path: /v1/apps/\{app_id\}/integrations/\{integration_id\}/sync/\{sync_id\}
Summary: Get sync job status
Description: Retrieves the current status and progress of a sync job
OpenAPI contract: integrations-api
Operation ID: Not documented in the OpenAPI contract.

Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID.

Parameters3 parameters

Name	In	Required	Type	Description
app_id	path	Yes	string	App UUID
integration_id	path	Yes	string	Integration UUID
sync_id	path	Yes	string	Sync UUID

Request bodyNo documented body

Not documented in the OpenAPI contract.

Responses3 statuses

Status	Description	Content
200	Sync job status	application/json
400	Invalid request	application/json (object)
500	Internal server error	application/json (object)

200 - object

Schema

Property	Type	Required	Details
`data`	object	No	-
`success`	boolean	No	-

Sync Status

Property	Type	Required	Details
`completed`	integer	No	-
`failed`	integer	No	-
`pending`	integer	No	-
`percentage_complete`	number	No	-
`processing`	integer	No	-
`sync_id`	string	No	-
`to_be_retried`	integer	No	-
`total`	integer	No	-

Generated example (synthetic):

{
  "data": {
    "completed": 0,
    "failed": 0,
    "pending": 0,
    "percentage_complete": 0,
    "processing": 0,
    "sync_id": "string",
    "to_be_retried": 0,
    "total": 0
  },
  "success": false
}

400 - object

Error

Property	Type	Required	Details
`details`	string	No	-
`error`	string	No	-
`success`	boolean	No	-

Generated example (synthetic):

{
  "details": "string",
  "error": "string",
  "success": false
}

500 - object

Error

Property	Type	Required	Details
`details`	string	No	-
`error`	string	No	-
`success`	boolean	No	-

Generated example (synthetic):

{
  "details": "string",
  "error": "string",
  "success": false
}

Contract identity

Use these fields to confirm you are implementing the intended endpoint contract.

API family: Integrations API
Method: GET
Path: /v1/apps/\{app_id\}/integrations/\{integration_id\}/sync/\{sync_id\}
Operation ID: Not documented in the OpenAPI contract.
OpenAPI tag: Sync
OpenAPI summary: Get sync job status