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, 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 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.

Requires permission branding.viewBranding

View the Environment's hosted-page branding. A scoped API key must hold it as a scope; a full-access key holds every scope within its Environment except the named-only and account scopes; a developer's token needs the Console capability that covers it. A credential without it is refused with 403.

Headers

  • X-Canopy-Environment

    The id of the Environment this request acts in. Required with an account API key, which belongs to the Account and names its Environment per request; an Environment key may send it only to name its own Environment. A missing header for an account key answers `400` (`api_key.environment_required`), one naming no Environment of the key's Account `400` (`api_key.environment_not_found`), and one naming another Environment than an Environment key's own `400` (`api_key.environment_mismatch`).

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. A request refused by an authorization check answers 403 with the code authorization.denied, and its data names the denial_reason and the permission checked.

403authorization.deniedForbidden
When it happens

The credential does not hold the permission this operation checks: a scoped API key without the scope, a developer without the Console capability that covers it, or a permission granted somewhere other than the node the request targets. The error's data names the permission.

Remediation

Add the permission named in the Authentication section to the key's scopes, or ask an account administrator to grant the covering capability, then retry. For a node-scoped operation, make sure the grant reaches the node you are acting on.

Returned object

EnvironmentBrandingResponseDtoView all properties on this resource
Request
curl -X GET "https://auth.canopy-io.com/api/v1/branding" \
  -H "X-Canopy-Environment: value" \
  -H "X-API-Key: $CANOPY_API_KEY"
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
PATCHChange an Environment's branding
 Was this page helpful?

Tell us how we can improve this guide.

Canopy