COcodatio
Integrations

Get branding for an integration

Changed on

Retrieve Integration branding assets.

get/config/integrations/{platformKey}/branding

Request

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

Path parameters

platformKeystring required

A unique 4-letter key to represent a platform in each integration. View accounting, banking, and commerce platform keys.

Example:gbol

A unique 4-letter key to represent a platform in each integration.

Response

Success

logoBrandingLogo (unresolved $ref)
buttonBrandingButton (unresolved $ref)
sourceIdstring uuid

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.

Example response

{
  "logo": {
    "full": {
      "image": {
        "src": "https://static.codat.io/public/officialLogos/Full/8A156A5A-39CB-4F9D-856E-76EF9B9A9607.png",
        "alt": "xero full icon"
      }
    },
    "square": {
      "image": {
        "src": "https://static.codat.io/public/officialLogos/Square/8A156A5A-39CB-4F9D-856E-76EF9B2W3607.png",
        "alt": "xero square icon"
      }
    }
  },
  "button": {
    "default": {
      "image": {
        "src": "https://static.codat.io/public/officialButtons/Full/8A156A5A-39CB-4F9D-856E-76EF9Q7A9607.png",
        "alt": "xero default button icon"
      }
    },
    "hover": {
      "image": {
        "src": "https://static.codat.io/public/officialLogos/Full/8A156A5A-39CB-4F9D-856E-76EF9B9A9607.png",
        "alt": "xero hover button icon"
      }
    }
  },
  "sourceId": "35b92968-9851-4095-ad60-395c95cbcba4"
}

Changes

  • 9bd87def9914Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 83c1801e91f7Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status