1. Docs
  2. API Reference
  3. List the hosted page and email texts whose wording can be changed

List the hosted page and email texts whose wording can be changed

GET/api/v1/branding/text-keys

Lists the texts on hosted pages and in emails that text_overrides can reword: the headings, labels, button labels and helper text of the sign-in, sign-up, account recovery, email verification, invitation, multi-factor challenge and sign-out pages, and the subject, heading, main sentence and button of the verification, password reset, sign-in code, two-step verification code, change confirmation and invitation emails. Each entry has the key an override names it by, its locale, the page or email it shows on, by the preview list's id, with its title and a preview_state that shows it, a plain name, its kind, its default wording, the placeholders an override must keep, and its max_length. Wording that tells a person what happened to their account (errors, refusals, expiry notices, warnings, and the security notice emails) is not listed and cannot be changed. Read this list before writing text_overrides. Returns 403 (plan_feature_unavailable) when the Account's plan does not include hosted page customization.

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

  • itemsBrandingTextKeyDto[]*

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

Request
curl -X GET "https://auth.canopy-io.com/api/v1/branding/text-keys" \
  -H "X-Canopy-Environment: value" \
  -H "X-API-Key: $CANOPY_API_KEY"
Response
{
  "items": [
    {
      "key": "authHosted.login.signInHeading",
      "locale": "en",
      "page": "login",
      "page_title": "Sign in",
      "preview_state": "Password",
      "name": "Heading",
      "kind": "heading",
      "default": "Sign in",
      "placeholders": [
        "name"
      ],
      "max_length": 80
    }
  ]
}
Related endpoints
GETGet an Environment's branding
PATCHChange an Environment's branding
GETList the hosted pages and emails a preview can render
GETList the fonts hosted pages can be set in
POSTPreview a hosted page or email in a branding
Was this page helpful?

Tell us how we can improve this guide.