Codat · Example Payload

Codat List Connections Example

Unified_API

Codat List Connections Example is an example object payload from Codat, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

{
  "operationId": "list-connections",
  "method": "GET",
  "path": "/companies/{companyId}/connections",
  "summary": "List connections",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "name": "Connections",
      "example": {
        "results": [
          {
            "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"
          }
        ],
        "pageNumber": 0,
        "pageSize": 0,
        "totalResults": 0,
        "_links": {
          "self": {
            "href": "string"
          },
          "current": {
            "href": "string"
          },
          "next": {
            "href": "string"
          },
          "previous": {
            "href": "string"
          }
        }
      }
    }
  ]
}