listAndCountApiKeys - API Key Module Reference

This documentation provides a reference to the listAndCountApiKeys 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 along with the total count of available API keys satisfying the provided filters.

Example#

To retrieve a list of API keys using their IDs:

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

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, count] =2  await apiKeyModuleService.listAndCountApiKeys(3    {4      id: ["apk_123", "apk_321"],5    },6    {7      take: 15,8      skip: 2,9    }10  )

Parameters#

filtersFilterableApiKeyPropsOptional

The filters to apply on the retrieved API keys.

configFindConfig<ApiKeyDTO>Optional

The configurations determining how the api API 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[], number]>

The list of API keys along with their total count.

Was this page helpful?