{
  "opencollection": "1.0.0",
  "info": {
    "name": "Bank Feeds Account mapping Connections API",
    "version": "3.0.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Connections",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List connections",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.codat.io/companies/:companyId/connections",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a company."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Page number. [Read more](https://docs.codat.io/using-the-api/paging)."
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging)."
              },
              {
                "name": "query",
                "value": "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
                "type": "query",
                "description": "Codat query string. [Read more](https://docs.codat.io/using-the-api/querying)."
              },
              {
                "name": "orderBy",
                "value": "",
                "type": "query",
                "description": "Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results)."
              }
            ]
          },
          "docs": "List the connections for a company."
        },
        {
          "info": {
            "name": "Create connection",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.codat.io/companies/:companyId/connections",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a company."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a connection for the company by providing a valid `platformKey`. \n\nUse the [List Integrations](https://docs.codat.io/platform-api#/operations/list-integrations) endpoint to access valid platform keys. "
        },
        {
          "info": {
            "name": "Get connection",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.codat.io/companies/:companyId/connections/:connectionId",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a company."
              },
              {
                "name": "connectionId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a connection."
              }
            ]
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "Unlink connection",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.codat.io/companies/:companyId/connections/:connectionId",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a company."
              },
              {
                "name": "connectionId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a connection."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "This allows you to deauthorize a connection, without deleting it from Codat. This means you can still view any data that has previously been pulled into Codat, and also lets you re-authorize in future if your customer wishes to resume sharing their data."
        },
        {
          "info": {
            "name": "Delete connection",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.codat.io/companies/:companyId/connections/:connectionId",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a company."
              },
              {
                "name": "connectionId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a connection."
              }
            ]
          },
          "docs": "Revoke and remove a connection from a company.\nThis operation is not reversible. The end user would need to reauthorize a new data connection if you wish to view new data for this company."
        },
        {
          "info": {
            "name": "Update authorization",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.codat.io/companies/:companyId/connections/:connectionId/authorization",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a company."
              },
              {
                "name": "connectionId",
                "value": "",
                "type": "path",
                "description": "Unique identifier for a connection."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update data connection's authorization."
        }
      ]
    }
  ],
  "bundled": true
}