---
title: "Get company configuration"
method: GET
path: "/config/companies/{companyId}/sync/commerce"
tags: ["Advanced controls"]
---

# Get company configuration

`GET /config/companies/{companyId}/sync/commerce`

Returns a company's commerce sync configuration'.

## Path parameters

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

## Response `200`

Success

- Configuration
  - `companyId` Schema — unresolved $ref
  - `accountingSoftwareCompanyName` string — The company name defined in the accounting software.
  - `enable` boolean — True if Sync for Commerce is enabled for the company.
  - `configured` boolean — True if Sync for Commerce has been configured for the company.
  - `schedule` SyncSchedule — unresolved $ref
  - `configuration` CommerceConfiguration — unresolved $ref

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

## Changes

- **2026-02-13** `929640e0cab2` — 1 breaking
  - the `companyId` response's property type/format changed from ``/`` to `string`/`uuid` for status `200`
- **2024-04-23** `a96819c0110c` — 4 warning, 6 info
  - removed the optional property `fees` from the response with the `200` status
  - removed the optional property `newPayments` from the response with the `200` status
  - removed the optional property `payments` from the response with the `200` status
  - removed the optional property `sales` from the response with the `200` status
  - …6 more
- **2024-02-13** `9bd87def9914` — 7 info
  - added the optional property `validation` to the response with the `401` status
  - added the optional property `validation` to the response with the `402` status
  - added the optional property `validation` to the response with the `403` status
  - added the optional property `validation` to the response with the `404` status
  - …3 more
- **2023-10-23** `83c1801e91f7` — 7 info
  - added the non-success response with the status `401`
  - added the non-success response with the status `402`
  - added the non-success response with the status `403`
  - added the non-success response with the status `404`
  - …3 more

[Change history](https://skmtc.dev/codatio/apis/codat-sync-commerce/changes/config/companies/:companyId/sync/commerce/get.md)

---

[API](https://skmtc.dev/codatio/apis/codat-sync-commerce.md) · [All operations](https://skmtc.dev/codatio/apis/codat-sync-commerce/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/codatio/codat-sync-commerce/revisions/f669e8c3c34f/schema)