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

List API keys for Application

GET/api/v1/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 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.

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 term

max length 200

sort_bystring Optional

Column to sort by. Allowed values depend on the endpoint.

orderenum Optional

Sort direction

one of "asc" · "desc"

Responses

application/json

  • itemsApiKeyResponseDto[]*
  • paginationPageMetaDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

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–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/api/v1/api-keys?page=0&take=0&q=value&sort_by=value&order=asc" \
  -H "X-API-Key: $CANOPY_API_KEY"
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
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