---
title: "Get an Agency customization Kit"
method: GET
path: "/v2/agency-CK/{agencyId}"
tags: ["Agency Customization Kit Api Service"]
---

# Get an Agency customization Kit

`GET /v2/agency-CK/{agencyId}`

## Request

- Base URL: `https://app.metricool.com/api`
- URL: `https://app.metricool.com/api/v2/agency-CK/{agencyId}`
- Auth: none declared

## Path parameters

- `agencyId` integer, required

## Response `200`

OK

- JsonOkResponseAgencyDto
  - `metadata` object
  - `page` JsonPaging
    - `next` string
  - `data` AgencyDto
    - `id` integer
    - `ownerId` integer
    - `domain` string
    - `loginUrl` string
    - `name` string
    - `enabled` boolean
    - `properties` AgencyPropertiesDto
      - `agencyLogo` string
      - `loginLogo` string
      - `faviconLogo` string
      - `supportChat` boolean
      - `helpArticles` boolean
      - `canvaIntegration` boolean: Whether the Canva integration is enabled for this agency's end clients
      - `driveIntegration` boolean: Whether the Google Drive integration is enabled for this agency's end clients
      - `colorPalette` ColorsDto: Chart colors, always the 13 of them (Metricool defaults where not customized).
        - `blue` string, required
        - `teal` string, required
        - `pink` string, required
        - `yellow` string, required
        - `lightYellow` string, required
        - `darkYellow` string, required
        - `purple` string, required
        - `cyan` string, required
        - `red` string, required
        - `green` string, required
        - `slate` string, required
        - `charcoal` string, required
        - `cobalt` string, required
      - `reportLogo` string
      - `mailMessage` string
      - `mailReplyTo` string
      - `mailLogo` string
      - `smtpConfiguration` CustomSMTPPropertiesDto
        - `host` string
        - `port` string
        - `user` string
        - `password` string
        - `from` string
        - `auth` string
        - `quitwait` string
        - `debug` string
        - `from.label` string
        - `socketFactory.class` string
        - `socketFactory.port` string
        - `starttls.enable` string
        - `ssl.protocols` string
        - `ssl.trust` string
      - `sesFrom` string
      - `sesFromLabel` string
      - `themeColorPalette` ThemeColorsDto: Optional white-label theme colors. Each field accepts a hex color (#RGB/#RRGGBB, alpha variants #RGBA/#RRGGBBAA included) or the literal 'transparent'. A field left null/blank falls back to the Metricool default when the color has never been customized; in a PATCH that only updates some of the 10 fields, a null/blank field instead keeps whatever was already saved for it - only sending the whole themeColorPalette object as null resets every color back to the default at once.
        - `topMenuBackgroundColor` string: Top menu background color
        - `topMenuTextColor` string: Top menu text color
        - `topMenuSeparatorColor` string: Top menu separator color
        - `primaryButtonBackgroundColor` string: Primary button background color
        - `primaryButtonBorderColor` string: Primary button border color
        - `primaryButtonTextColor` string: Primary button text color
        - `secondaryButtonBackgroundColor` string: Secondary button background color
        - `secondaryButtonBorderColor` string: Secondary button border color
        - `secondaryButtonTextColor` string: Secondary button text color
        - `backgroundColor` string: General background color
        - `customizedColors` string[]: Names of the fields above that were actually customized, in the same order as the fields themselves. Any field not listed here is equal to the Metricool default - a frontend rendering per-screen defaults should only apply the fields listed here and leave the rest untouched.

---

[API](https://skmtc.dev/metricool/apis/metricool-api.md) · [All operations](https://skmtc.dev/metricool/apis/metricool-api/llms.txt) · [OpenAPI document](https://skmtc.dev/metricool/apis/metricool-api/revisions/cd0ca612fa01?raw)