retrieve - API Key Module Reference

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

This method retrieves an API key by its ID.

Example

const apiKey = await apiKeyModuleService.retrieve("apk_123")

Parameters

idstringRequired

The ID of the API key.

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 retrieved API key.