1. Docs
  2. API Reference
  3. List API keys for Application

List API keys for Application

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

Returns a paginated list of every API key issued for the active Application, scoped to the current Environment. Keys are returned with metadata only — key_preview, access_mode, scopes, is_active, last_used_at, and expires_at — the secret value is shown once at creation and never again. Use the query parameters below to page, search keys by name, and sort by name or created (default: newest first).

Authentication

Bearer TokenAuthorization

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

Requires capability api_keys.viewDeveloper Console

View API keys. 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

The Environment's slug within the Application.

Query Parameters

pagenumber Optional

Page number (1-based)

min 1

takenumber Optional

Items per page (1-100, default 20)

range 1–100

qstring Optional

Search key names

max length 200

sort_byenum Optional

Sort column. Defaults to `created`, newest first.

one of "name" · "created"

orderenum Optional

Sort direction

one of "asc" · "desc"

Responses

application/json

  • itemsApiKeyResponseDto[]*
  • paginationPageMetaDto*

application/json

  • errorApiErrorBodyDto*

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.

Pagination

This endpoint returns a paginated collection. Use the query parameters below to page through results.

pagenumber

Page number (1-indexed). Defaults to 1.

takenumber

Items per page (1 to 100). Defaults to 20.

Each response includes an items array alongside a pagination object with item_count, page_count, has_previous_page, and has_next_page fields.

Returned object

ApiKeyResponseDtoView all properties on this resource
Request
curl -X GET "https://auth.canopy-io.com/portal/v1/accounts/value/applications/value/environments/value/api-keys?page=0&take=0&q=value&sort_by=name&order=asc" \
  -H "Authorization: Bearer $CANOPY_TOKEN"
Response
{
  "items": [
    {
      "id": "string",
      "client_id": "string",
      "name": "string",
      "description": "string",
      "key_preview": "string",
      "access_mode": "scoped",
      "scopes": [
        "string"
      ],
      "is_active": false,
      "last_used_at": "2026-04-20T12:00:00.000Z",
      "expires_at": "2026-04-20T12:00:00.000Z",
      "created_at": "2026-04-20T12:00:00.000Z"
    }
  ],
  "pagination": {
    "page": 0,
    "take": 0,
    "item_count": 0,
    "page_count": 0,
    "has_previous_page": false,
    "has_next_page": false
  }
}
 Related endpoints
POSTCreate a new API key
GETList the permission scopes a scoped key can hold
GETActive/inactive API key counts for the environment
PATCHActivate or deactivate an API key
DELETEDelete an API key
POSTRotate an API key's secret
 Was this page helpful?

Tell us how we can improve this guide.

Canopy