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

# Get company info

`GET /companies/{companyId}/data/info`

Gets the latest basic info for a company.

## Path parameters

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

## Response `200`

Success

- CompanyInformation — Company info provides standard details about a linked company such as their address, phone number, and company registration. > **Company information or companies?** > > Company information is standard information that is held in the accounting software about a company. `Companies` is an endpoint that lists businesses in the Codat system that have linked and shared their data sources.
  - `companyName` string, nullable — Name of the linked company.
  - `accountingPlatformRef` string, nullable — Identifier or reference for the company in the accounting software.
  - `companyLegalName` string, nullable — Registered legal name of the linked company.
  - `addresses` object[], nullable — An array of Addresses.
    - `type` AccountingAddressType, required — unresolved $ref
    - `line1` string, nullable — Line 1 of the customer address.
    - `line2` string, nullable — Line 2 of the customer address.
    - `city` string, nullable — City of the customer address.
    - `region` string, nullable — Region of the customer address.
    - `country` string, nullable — Country of the customer address.
    - `postalCode` string, nullable — Postal code or zip code.
  - `phoneNumbers` object[], nullable — An array of phone numbers.
    - `number` string, nullable — A phone number.
    - `type` 'Primary' | 'Landline' | 'Mobile' | 'Fax' | 'Unknown', required — The type of phone number
  - `webLinks` object[], nullable — An array of weblinks.
    - `type` 'Website' | 'Social' | 'Unknown' — The type of the weblink.
    - `url` string, url — The full URL for the weblink.
  - `ledgerLockDate` 1 — unresolved $ref
  - `registrationNumber` string, nullable — Registration number given to the linked company by the companies authority in the country of origin. In the UK this is Companies House.
  - `taxNumber` string, nullable — Company tax number.
  - `financialYearStartDate` 1 — unresolved $ref
  - `baseCurrency` string, nullable — Currency set in the accounting software of the linked company. Used by the currency rate.
  - `sourceUrls` object, nullable — URL addresses for the accounting source. For example, for Xero integrations two URLs are returned. These have many potential use cases, such as [deep linking](https://developer.xero.com/documentation/api-guides/deep-link-xero).
  - `createdDate` 1 — unresolved $ref
  - `supplementalData` SupplementalData — Supplemental data is additional data you can include in our standard data types. It is referenced as a configured dynamic key value pair that is unique to the accounting software. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data.
    - `content` object, nullable

## 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/sync-for-expenses-v1.md) · [All operations](https://skmtc.net/codatio/apis/sync-for-expenses-v1/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/codatio/sync-for-expenses-v1/revisions/3a810b6f9c66/schema)