list - API Key Module Reference

This documentation provides a reference to the list method. This belongs to the API Key Module.

This method retrieves a paginated list of API keys based on optional filters and configuration.

Example

To retrieve a list of API keys using their IDs:

const apiKeys = await apiKeyModuleService.list({
  id: ["apk_123", "apk_321"]
})

By default, only the first 15 records are retrieved. You can control pagination by specifying the skip and take properties of the config parameter:

const apiKeys = await apiKeyModuleService.list(
  {
    id: ["apk_123", "apk_321"],
  },
  {
    take: 20,
    skip: 2,
  }
)

Parameters

filtersFilterableApiKeyProps

The filters to apply on the retrieved API keys.

configFindConfig<ApiKeyDTO>

The configurations determining how the API key is retrieved. Its properties, such as select or relations, accept the attributes or relations associated with a API key.

sharedContextContext

A context used to share resources, such as transaction manager, between the application and the module.

Returns

PromisePromise<ApiKeyDTO[]>Required

The list of API keys.