listApiKeys - API Key Module Reference

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

Note: You should only use this methods when implementing complex customizations. For common cases, check out available workflows instead.

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:

Code
1const apiKeys = await apiKeyModuleService.listApiKeys({2  id: ["apk_123", "apk_321"]3})

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

Code
1const apiKeys = await apiKeyModuleService.listApiKeys(2  {3    id: ["apk_123", "apk_321"],4  },5  {6    take: 20,7    skip: 2,8  }9)

Parameters#

filtersFilterableApiKeyPropsOptional

The filters to apply on the retrieved API keys.

configFindConfig<ApiKeyDTO>Optional

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.

sharedContextContextOptional

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

Returns#

PromisePromise<ApiKeyDTO[]>

The list of API keys.

Was this page helpful?