1. Docs
  2. API Reference
  3. List the environment's publishable keys

List the environment's publishable keys

GET/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/publishable-keys

Returns every live publishable key on this Environment with its type. An Environment normally holds more than one — a web key for a browser app and a native key for a phone app — because the type decides how a session created with that key receives its refresh token.

Authentication

Bearer TokenAuthorization

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

Requires capability publishable_keys.viewDeveloper Console

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

Responses

application/json

  • itemsPublishableKeyResponseDto[]*

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.

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

PublishableKeyResponseDtoView all properties on this resource
Request
curl -X GET "https://auth.canopy-io.com/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/publishable-keys" \
  -H "Authorization: Bearer $CANOPY_TOKEN"
Response
{
  "items": [
    {
      "id": "string",
      "key": "string",
      "type": "web",
      "name": "string",
      "created_at": "2026-04-20T12:00:00.000Z"
    }
  ]
}
 Related endpoints
POSTCreate a publishable key
PATCHRename a publishable key
DELETERevoke a publishable key
 Was this page helpful?

Tell us how we can improve this guide.

Canopy