---
title: "Get sync status"
method: GET
path: "/companies/{companyId}/sync/expenses/syncs/{syncId}/status"
tags: ["Sync"]
---

# Get sync status

`GET /companies/{companyId}/sync/expenses/syncs/{syncId}/status`

## Request

- Base URL: `https://api.codat.io`
- URL: `https://api.codat.io/companies/{companyId}/sync/expenses/syncs/{syncId}/status`
- Auth: API key in header `Authorization`

Get the sync status for a specified sync

## Path parameters

- `companyId` string, uuid, required: Unique identifier for your SMB in Codat.
- `syncId` string, uuid, required

## Response `200`

Success

- CompanySyncStatus
  - `companyId` string, nullable: Unique identifier for your SMB in Codat.
  - `syncId` string, nullable: Unique identifier of the sync.
  - `syncStatusCode` integer: Status code of the sync.
  - `syncStatus` string, nullable: Text status of the sync.
  - `errorMessage` string, nullable: Error message of the sync.
  - `syncExceptionMessage` string, nullable: Exception message of the sync.
  - `syncUtc` 1 (unresolved $ref)
  - `dataPushed` boolean: Boolean of whether the sync resulted in data being pushed.

## Other responses

- `401`: Your API request was not properly authorized.
- `402`: An account limit has been exceeded. The type of limit is described in the error property: - You have exceeded the 50-company limit that applies to a Free plan. Delete any companies you no longer need and retry the request. - The requested sync schedule is not allowed. You requested an hourly sync schedule but this functionality is not included in the Free plan. - Your Free account is older than 365 days and has expired. Contact support@codat.io.
- `403`: You are using an outdated API key or a key not associated with that resource.
- `404`: One or more of the resources you referenced could not be found. This might be because your company or data connection id is wrong, or was already deleted.
- `429`: Too many requests were made in a given amount of time. Wait a short period and then try again.
- `500`: There is a problem with our server. Please try again later.
- `503`: The Codat API is temporarily offline for maintenance. Please try again later.

---

[API](https://skmtc.dev/codatio/apis/sync-for-expenses-v1.md) - [All operations](https://skmtc.dev/codatio/apis/sync-for-expenses-v1/llms.txt) - [OpenAPI document](https://skmtc.dev/codatio/apis/sync-for-expenses-v1/revisions/ca501f1fd9a0?raw)