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

Get an Environment's branding

GET/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/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, favicon, primary and background colors, support, terms and privacy links, and whether the attribution mark stays). Only the primary color has a default; every other unset field is null. brand_removal_available says whether the Account's plan removes the attribution mark.

Authentication

Bearer TokenAuthorization

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

Requires capability env_branding.viewDeveloper Console

View Environment branding. Granted through an administrator role in the Admin Workspace; a valid token without it is refused with 403.

Path Parameters

accountSlugstring Required

The Account's slug. An unknown one answers 404.

appSlugstring Required

The Application's slug within the Account.

envSlugstring Required

Responses

application/json

  • dataEnvironmentBrandingResponseDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Errors

When the request can't be completed, the response body includes a stable error code you can branch on, and a correlation_id (also sent as the X-Correlation-Id header). Quote the correlation id when you contact support: it identifies the exact request in Canopy's logs.

403account.capability_requiredForbidden
When it happens

The signed-in user's administrator roles do not grant the capability this endpoint requires.

Remediation

Ask an account administrator to grant a role carrying the capability named in the Authentication section, then retry.

Returned object

EnvironmentBrandingResponseDtoView all properties on this resource
Request
curl -X GET "https://auth.canopy-io.com/portal/v1/accounts/value/applications/value/environments/value/branding" \
  -H "Authorization: Bearer $CANOPY_TOKEN"
Response
{
  "data": {
    "environment_slug": "string",
    "branding": {
      "product_name": "string",
      "logo_url": "string",
      "logo_kind": "full",
      "favicon_url": "string",
      "primary_color": "string",
      "background_color": "string",
      "support_url": "string",
      "terms_url": "string",
      "privacy_url": "string"
    },
    "effective": {
      "product_name": "string",
      "logo_url": "string",
      "logo_kind": "full",
      "favicon_url": "string",
      "primary_color": "string",
      "background_color": "string",
      "support_url": "string",
      "terms_url": "string",
      "privacy_url": "string",
      "attribution": false
    },
    "brand_removal_available": false
  }
}
 Related endpoints
GETList Environments in an Application
POSTCreate a new Environment in an Application
GETGet a single Environment by slug
PATCHRename or re-slug an Environment
DELETEDelete an Environment
GETGet an Environment's sign-in settings
PATCHChange an Environment's sign-in settings
PATCHChange an Environment's branding
GETExport an Environment's configuration as JSON
POSTReplace an Environment's configuration from a JSON payload (destructive)
GETGet the Environment's access model
PUTSwitch the Environment's access model
PUTSwitch the Environment's organizations container on or off
GETGet hierarchy schema for the active Environment
PATCHUpdate hierarchy schema for the active Environment
GETList hierarchy node types with existing nodes
POSTRevert this Environment from hierarchy to flat
 Was this page helpful?

Tell us how we can improve this guide.

Canopy