Companies

List companies

The List companies endpoint returns a list of companies associated to your instances.

A company represents a business sharing access to their data. Each company can have multiple connections to different data sources, such as one connection to Xero for accounting data, two connections to Plaid for two bank accounts, and a connection to Zettle for POS data.

Filter by tags

The List companies endpoint supports the filtering of companies using tags. It supports the following operators with Codat’s query language:

equals (=)
not equals (!=)
contains (~)

For example, you can use the querying to filter companies tagged with a specific foreign key, region, or owning team:

Foreign key: uid = {yourCustomerId}
Region: region != uk
Owning team and region: region = uk && owningTeam = invoice-finance

get/companies

Query parameters

pageinteger

Example:1

Page number. Read more.

pageSizeinteger

Example:100

Number of records to return in a page. Read more.

querystring

Codat query string. Read more.

orderBystring

Example:-modifiedDate

Field to order results by. Read more.

tagsstring

Filter companies by tags using the "equals" (=), "not equals" (!=), and "contains" (~) operators with Codat’s query language.

Response

Companies required— unresolved $ref

Changes

Changed in 9 of the 52 revisions of this API.715

Jul 22, 2026476e1f8f0a861See the full diff
- ○
  added the optional property allOf[subschema #1]/results/items/allOf[subschema #1: Company details]/ownerUserIds to the response with the 200 status
  response-optional-property-added
Apr 15, 20264cec2042759e1See the full diff
- ▲
  the response property allOf[subschema #1]/results/items/allOf[subschema #2]/dataConnections/items/integrationKey became optional for the status 200
  response-property-became-optional
Dec 16, 202424a169c146c91See the full diff
- ○
  added the new optional query request parameter tags
  new-optional-request-parameter
Nov 13, 2024732b5851d6a72See the full diff
- ○
  added the optional property allOf[subschema #1]/results/items/allOf[subschema #1: Company details]/referenceParentCompany to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property allOf[subschema #1]/results/items/allOf[subschema #1: Company details]/referenceSubsidiaryCompanies to the response with the 200 status
  response-optional-property-added
Sep 26, 2024f64df5c655ec1See the full diff
- ▲
  the response property allOf[subschema #1]/results/items/allOf[subschema #2]/dataConnections/items/dataConnectionErrors became nullable for the status 200
  response-property-became-nullable
Sep 23, 20242d8788c802502See the full diff
- ▲
  the response property allOf[subschema #1]/results/items/allOf[subschema #2]/dataConnections/items/connectionInfo became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[subschema #1]/results/items/allOf[subschema #2]/dataConnections/items/lastSync became nullable for the status 200
  response-property-became-nullable
Sep 23, 2024d64723f7f6511See the full diff
- ●
  removed the optional property allOf[subschema #1]/results/items/allOf[subschema #2]/dataConnections/items/additionalProperties from the response with the 200 status
  response-optional-property-removed
Sep 16, 2024c9dd95e7c6a01See the full diff
- ○
  added the optional property allOf[subschema #1]/results/items/allOf[subschema #1: Company details]/products to the response with the 200 status
  response-optional-property-added
Sep 12, 20248ddc0468f6323See the full diff
- ▲
  the response property allOf[subschema #1]/results/items/allOf[subschema #1: Company details]/createdByUserName became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[subschema #1]/results/items/allOf[subschema #1: Company details]/description became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property allOf[subschema #1]/results/items/allOf[subschema #1: Company details]/lastSync became nullable for the status 200
  response-property-became-nullable

Full history