Sign in
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

OK

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.

sourceIdstring 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.

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
lastSync1 — unresolved $ref
created1 required— unresolved $ref
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"
}