Connections

Get connection

Returns a specific connection for a company when valid identifiers are provided. If the identifiers are for a deleted company and/or connection, a not found response is returned.

get/companies/{companyId}/connections/{connectionId}

Path parameters

companyIdstring uuid required

Unique identifier for your SMB in Codat.

Example:8a210b68-6988-11ed-a1eb-0242ac120002

Unique identifier for a company.

connectionIdstring uuid required

Unique identifier for a company's data connection.

Example:2e9d2c44-f675-40ba-8049-353bfcb5e171

Unique identifier for a connection.

Response

idSchema required— unresolved $ref

integrationIdstring uuid required

A Codat ID representing the integration.

integrationKeystring

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.

sourceIdSourceId required— unresolved $ref

sourceTypeSourceType required— unresolved $ref

platformNamestring required

Name of integration connected to company.

linkUrlstring uri required

The link URL your customers can use to authorize access to their business application.

statusDataConnectionStatus required— unresolved $ref

lastSyncstring

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.

createdstring required

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.

dataConnectionErrorsDataConnectionError[] nullable— unresolved $ref

connectionInfoobject nullable

Example response

{
  "id": "ee2eb431-c0fa-4dc9-93fa-d29781c12bcd",
  "integrationId": "bf083d72-62c7-493e-aec9-81b4dbba7e2c",
  "integrationKey": "dfxm",
  "sourceId": "bdd831ce-eebd-4896-89a7-20e5ee8989ee",
  "platformName": "Basiq",
  "linkUrl": "https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start",
  "status": "Linked",
  "lastSync": "2022-10-27T10:22:43.6464237Z",
  "created": "2022-10-27T09:53:29Z",
  "sourceType": "Banking"
}

Changes

Changed in 6 of the 52 revisions of this API.412

Aug 4, 2026bff9b9776ecf1See the full diff
- ○
  for the path request parameter companyId, the type/format was generalized from / to string/uuid
  request-parameter-type-generalized
Apr 15, 2026f9ec5126044c1See the full diff
- ▲
  the response property integrationKey became optional for the status 200
  response-property-became-optional
Feb 13, 20261834c78d88a51See the full diff
- ○
  for the path request parameter companyId, the type/format was generalized from string/uuid to /
  request-parameter-type-generalized
Sep 26, 202426fd1967e4501See the full diff
- ▲
  the response property dataConnectionErrors became nullable for the status 200
  response-property-became-nullable
Sep 23, 2024429a1658d7b12See the full diff
- ▲
  the response property connectionInfo became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property lastSync became nullable for the status 200
  response-property-became-nullable
Sep 23, 2024b8afb1b754231See the full diff
- ●
  removed the optional property additionalProperties from the response with the 200 status
  response-optional-property-removed

Full history