Connections

List connections

List the connections for a company.

get/companies/{companyId}/connections

Path parameters

companyIdstring uuid required

Unique identifier for your SMB in Codat.

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

Unique identifier for a company.

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.

Response

pageNumberinteger required

Current page number.

pageSizeinteger required

Number of items to return in results array.

totalResultsinteger required

Total number of items.

_linksLinks required— unresolved $ref

Example response

{
  "pageNumber": 1,
  "pageSize": 10,
  "totalResults": 1,
  "_links": {
    "self": {
      "href": "/companies/{id}/data/{dataType}"
    },
    "current": {
      "href": "/companies/{id}/data/{dataType}?page=1&pageSize=10"
    }
  }
}

Changes

Changed in 8 of the 52 revisions of this API.4310

Apr 15, 20260351fe91ea521See the full diff
- ▲
  the response property /// became optional for the status
  response-property-became-optional
Sep 26, 20244882f7ca4bfb1See the full diff
- ▲
  the response property /// became nullable for the status
  response-property-became-nullable
Sep 23, 2024cac991dff0f22See the full diff
- ▲
  the response property /// became nullable for the status
  response-property-became-nullable
- ▲
  the response property /// became nullable for the status
  response-property-became-nullable
Sep 23, 202429ff3fef7e321See the full diff
- ●
  removed the optional property /// from the response with the status
  response-optional-property-removed
May 24, 2024df3e689279be2See the full diff
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///// to the response with the status
  response-optional-property-added
Feb 13, 2024fc70787de2f38See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
Dec 21, 202365a4026315cc1See the full diff
- ●
  added the new Expense enum value to the /// response property for the response status
  response-property-enum-value-added
Dec 21, 20236b5fa00849b51See the full diff
- ●
  added the new BankFeed enum value to the /// response property for the response status
  response-property-enum-value-added

Full history