`list()`

Warning

API keys is currently in beta. The API may change before general availability.

Retrieves a list of API keys for a given user or organization. Returns a PaginatedResourceResponse object.

function list(
  queryParams: GetAPIKeyListParams,
): Promise<PaginatedResourceResponse<APIKeyResource[]>>

`GetAPIKeyListParams`

Note

Using clerkClient varies based on your framework. Refer to the JS Backend SDK overview for usage details, including guidance on how to access the userId and other properties.

const userId = 'user_123'

const apiKeys = await clerkClient.apiKeys.list({
  subject: userId,
})

const userId = 'user_123'

const apiKeys = await clerkClient.apiKeys.list({
  subject: userId,
  includeInvalid: true,
})

const userId = 'user_123'

const apiKeys = await clerkClient.apiKeys.list({
  subject: userId,
  limit: 20,
  offset: 0,
})

This method in the SDK is a wrapper around the BAPI endpoint GET/api_keys. See the BAPI reference for more information.

Last updated on Dec 15, 2025