Sign in
latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-05222395.4 KB

f669e8c3c34f

Sync

Get sync status

Gets a list of sync statuses.

get/meta/companies/{companyId}/sync/commerce/status

Path parameters

companyIdstring uuid required

Unique identifier for your SMB in Codat.

Example:8a210b68-6988-11ed-a1eb-0242ac120002

Unique identifier for a company.

Response

Success

companyIdSchema — unresolved $ref
commerceSyncIdstring guid

Unique identifier for the sync in Codat.

syncIdstring uuid

Unique identifier for the sync in Codat.

syncStatusCodeinteger

Numerical status code sync of the company data.

syncStatusstring nullable

Status of the sync of the company data. This is linked to status code.

errorMessagestring nullable

Friendly error message for the sync operation.

syncExceptionMessagestring nullable

Exception message for the sync operation.

syncUtcCreated — unresolved $ref
dataPushedboolean

Boolean indicator for data being pushed during a sync operation.