---
title: "Lists all available API keys."
method: GET
path: "/accessmanagement/api-key"
tags: ["accessmanagement - api keys"]
---

# Lists all available API keys.

`GET /accessmanagement/api-key`

## Request

- Base URL: `https://manager.digicertdns.com/v1`
- URL: `https://manager.digicertdns.com/v1/accessmanagement/api-key`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/digicert/apis/digicert-dns/docs/accessmanagement/api-key/get.ts> (a function with typed inputs; its response is checked against the schema)

This endpoint lists all available API keys, providing users with full visibility into the keys associated with their account.</br></br>Key features include:</br></br>- **Clear success messaging:** Returns a `200` success code with a confirmation message indicating the successful completion of the requested action.</br>- **Controlled data limits:** The `pageSize` parameter allows users to define the maximum number of API keys to display per page, optimizing data retrieval for specific use cases.</br>- **Customizable pagination:** The `pageNumber` parameter allows users to specify the page of results they wish to retrieve, ensuring targeted access to data.</br>- **Efficient sorting:** The `sortBy` parameter enables users to organize responses by various attributes, offering flexibility in result management.</br>- **Targeted data retrieval:** Employs the `userId` parameter to return the specified user's API keys, ensuring accuracy and relevance in the response

## Query parameters

- `pageSize` integer
- `pageNumber` integer
- `userId` integer
- `sortBy` 'createdTsAsc' | 'createdTsDesc' | 'modifiedTsAsc' | 'modifiedTsDesc' | 'lastUsedTsAsc' | 'lastUsedTsDesc' | 'expirationDateAsc' | 'expirationDateDesc' | 'nameAsc' | 'nameDesc'
- `type` 'service' | 'user'

## Response `200`

API keys listed successfully.

- ApiKeyPaginated
  - `data` ApiKeyResponse[]
    - `id` string
    - `name` string
    - `username` string
    - `userId` string
    - `keySuffix` string
    - `expirationDate` string, date-time, nullable
    - `note` string, nullable
    - `status` 'ACTIVE' | 'DISABLED' | 'EXPIRED'
    - `type` 'USER' | 'SERVICE'
    - `lastUsedTs` string, date-time
    - `createdTs` string, date-time
    - `modifiedTs` string, date-time
    - `roles` ServiceKeyResponseFieldsRoles[]
      - `id` integer
      - `name` string
      - `description` string
    - `resourceGroups` ServiceKeyResponseFieldsResourceGroups[]
      - `id` integer
      - `name` string
      - `description` string
      - `isDefault` boolean
    - `userGroups` ServiceKeyResponseFieldsUserGroups[]
      - `id` integer
      - `name` string
      - `description` string
      - `isDefault` boolean
  - `total` integer
  - `count` integer
  - `perPage` integer
  - `currentPage` integer
  - `totalPages` integer

## Other responses

- `404`: Resource not found.

---

[API](https://skmtc.dev/digicert/apis/digicert-dns.md) - [All operations](https://skmtc.dev/digicert/apis/digicert-dns/llms.txt) - [OpenAPI document](https://skmtc.dev/digicert/apis/digicert-dns/revisions/c74fc728cff8?raw)