---
title: "Get company info"
method: GET
path: "/companies/{companyId}/connections/{connectionId}/data/commerce-info"
tags: ["Company info"]
---

# Get company info

`GET /companies/{companyId}/connections/{connectionId}/data/commerce-info`

Retrieve information about the company, as seen in the commerce software.

This may include information like addresses, tax registration details and social media or website information.

## Response `200`

OK

- CompanyInfo, nullable — In the Codat system, company profile includes standard commercial details about a linked company, such as their address, phone number, and company registration.
  - `companyName` string — The name of the company
  - `commercePlatformRef` string — Identifier or reference for the company in the commerce software
  - `companyLegalName` string — The full legal name of the company
  - `addresses` Address[] — Addresses associated with the company
    - `type` CommerceAddressType — unresolved $ref
    - `line1` string — The first line of the address
    - `line2` string — The second line of the address
    - `city` string — The third line of the address, or city
    - `region` string — The fourth line of the address, or region
    - `country` string — The country for the address
    - `postalCode` string — The postal (or zip) code for the address
  - `phoneNumbers` PhoneNumber[] — Phone numbers associated with the company
    - `number` string, nullable — A phone number.
    - `type` 'Primary' | 'Landline' | 'Mobile' | 'Fax' | 'Unknown', required — The type of phone number
  - `webLinks` object[] — Weblinks associated with the company
    - `type` 'Website' | 'Social' | 'Unknown' — The type of the weblink.
    - `url` string, url — The full URL for the weblink.
  - `registrationNumber` string — The registration number of the company
  - `baseCurrency` Currency — unresolved $ref
  - `accountBalances` AccountBalance[] — The available and current cash balances for the company's accounts — unresolved $ref
  - `sourceUrls` object — URL addresses for the originating system. For example, potential use cases include 'deeplinking' to the originating system
  - `createdDate` string — In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example: ``` 2020-10-08T22:40:50Z 2021-01-01T00:00:00 ``` When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - Unqualified local time: `2021-11-15T01:00:00` - UTC time offsets: `2021-11-15T01:00:00-05:00` > Time zones > > Not all dates from Codat will contain information about time zones. > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced.
  - `modifiedDate` string — The date when the record was last fetched from the accounting software, commerce software, or open banking provider and updated in Codat’s data cache. Use it to identify and retrieve records that have changed since your last fetch. For example, filtering `modifiedDate` to today will provide new records updated in Codat today. This date is populated for all data types except for attachments, balance sheets, company information, and profit & loss reports ([read more](https://docs.codat.io/using-the-api/modified-dates#modified-date)). In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>.
  - `sourceModifiedDate` string — The date when a record was last modified in the accounting software, usually by the business or a business process. For example, when payments are made against an invoice. It is not populated ([read more](https://docs.codat.io/using-the-api/modified-dates#source-modified-date)) when: - Pulling attachments - The accounting software does not provide modification dates for a data type - A record has been deleted from the source platform and Codat doesn't have a record of when the deletion occurred - A record has been voided. For certain platforms that soft delete records, `isDeleted` metadata is used to identify void records In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>.

## 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.
- `409` — The data type's dataset has not been requested or is still syncing.
- `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.net/codatio/apis/commerce-api.md) · [All operations](https://skmtc.net/codatio/apis/commerce-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/codatio/commerce-api/revisions/c56aa8f7d9f2/schema)