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