COcodatio
Integrations

Get integration

Get single integration, by platformKey

get/integrations/{platformKey}

Request

  • Base URL
    https://api.codat.io
  • URL
    https://api.codat.io/integrations/{platformKey}
  • Auth
    API key in header Authorization

Response

OK

keySchema required(unresolved $ref)
logoUrlstring uri required

Static url for integration's logo.

namestring required

Name of integration.

enabledboolean required

Whether this integration is enabled for your customers to use.

sourceIdSourceId (unresolved $ref)
sourceTypeSourceType (unresolved $ref)
integrationIdIntegrationId (unresolved $ref)
isOfflineConnectorboolean

True if the integration is to an application installed and run locally on an SMBs computer.

isBetaboolean

True if the integration is currently in beta release.

dataProvidedBystring

The name of the data provider.

datatypeFeaturesDataTypeFeature[] (unresolved $ref)

Example response

{
  "key": "gbol",
  "logoUrl": "http://example.com",
  "name": "Xero",
  "enabled": true,
  "sourceId": "accounting",
  "sourceType": "8193a927-ab7a-45a3-9dc2-d357a4932dfe",
  "integrationId": "497a18ca-284e-40c0-985d-f72be35d468e",
  "isOfflineConnector": true,
  "isBeta": true,
  "dataProvidedBy": "string",
  "datatypeFeatures": [
    {
      "datatype": "invoices",
      "supportedFeatures": [
        {
          "featureType": "get",
          "featureState": "release"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 72 revisions of this API.