1. Docs
  2. API Reference
  3. Get an Environment's branding

Get an Environment's branding

GET/api/v1/branding

Returns the Environment's branding: the values the customer set (branding, null where unset) beside the effective result every hosted page and the organization admin portal render (effective: product name, logo, primary color, support link, and whether the attribution line stays). brand_removal_available says whether the Account's plan removes the attribution line.

Authentication

Bearer TokenAuthorization Option A

JWT access token. Never send alongside X-API-Key: a request carrying both is refused.

API KeyX-API-Key Option B

API key for management-tier access. Never send alongside an Authorization header: a request carrying both is refused.

Responses

application/json

  • dataEnvironmentBrandingResponseDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Returned object

EnvironmentBrandingResponseDtoView all properties on this resource
Request
curl -X GET "https://auth.canopy-io.com/api/v1/branding" \
  -H "X-API-Key: $CANOPY_API_KEY"
Response
{
  "data": {
    "environment_slug": "string",
    "branding": {
      "product_name": "string",
      "logo_url": "string",
      "primary_color": "string",
      "support_url": "string"
    },
    "effective": {
      "product_name": "string",
      "logo_url": "string",
      "primary_color": "string",
      "support_url": "string",
      "attribution": false
    },
    "brand_removal_available": false
  }
}
 Related endpoints
PATCHChange an Environment's branding
 Was this page helpful?

Tell us how we can improve this guide.

Canopy