Skip to main content

get()

Note

Looking for the and you use to connect your own app to Clerk? Those are different from the API keys described here. You can copy them from the API keys page in the Clerk Dashboard, or learn more in the Clerk environment variables reference.

Gets the given APIKey object.

function get(apiKeyId: string): Promise<APIKey>

Parameters

  • Name
    apiKeyId
    Type
    string
    Description

    The ID of the API key to get.

Usage

Note

Using clerkClient varies based on the SDK you're using. Refer to the overview for usage details, including guidance on how to access the userId and other properties.

const apiKeyId = 'apikey_123'

const response = await clerkClient.apiKeys.get(apiKeyId)

Backend API (BAPI) endpoint

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

Feedback

What did you think of this content?

Last updated on

GitHubEdit on GitHub