---
title: "List connections"
method: GET
path: "/companies/{companyId}/connections"
tags: ["Connections"]
---

# List connections

`GET /companies/{companyId}/connections`

List the connections for a company.

## Path parameters

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

## Query parameters

- `page` integer
- `pageSize` integer
- `query` string
- `orderBy` string

## Response `200`

OK

- Connections
  - `results` Connection[]
    - `id` Schema, required — unresolved $ref
    - `integrationId` string, uuid, required — A Codat ID representing the integration.
    - `integrationKey` string — A unique four-character ID that identifies the platform of the company's data connection. This ensures continuity if the platform changes its name in the future.
    - `sourceId` string, uuid, required — A source-specific ID used to distinguish between different sources originating from the same data connection. In general, a data connection is a single data source. However, for TrueLayer, `sourceId` is associated with a specific bank and has a many-to-one relationship with the `integrationId`.
    - `sourceType` 'Accounting' | 'Banking' | 'BankFeed' | 'Commerce' | 'Expense' | 'Other' | 'Unknown', required — The type of platform of the connection.
    - `platformName` string, required — Name of integration connected to company.
    - `linkUrl` string, uri, required — The link URL your customers can use to authorize access to their business application.
    - `status` DataConnectionStatus, required — unresolved $ref
    - `lastSync` 1 — unresolved $ref
    - `created` 1, required — unresolved $ref
    - `dataConnectionErrors` DataConnectionError[], nullable — unresolved $ref
    - `connectionInfo` object, nullable
  - `pageNumber` integer, required — Current page number.
  - `pageSize` integer, required — Number of items to return in results array.
  - `totalResults` integer, required — Total number of items.
  - `_links` Links, required — unresolved $ref

## Other responses

- `400` — Your `query` parameter was not correctly formed
- `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.

---

[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)
