Get API key

Get details about an API key.

organizationId · string · required

Unique identifier for a given organization.

apiKeyId · string · required

Unique identifier for a given API key.

A successful response returns the following fields:

apiKey · object · required

apiKey field

Show apiKey details

cURL

curl --request POST \
  --url https://api.turnkey.com/public/v1/query/get_api_key \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <string> (see Authorizations)" \
  --data '{
    "organizationId": "<string>",
    "apiKeyId": "<string>"
}'

import { Turnkey } from "@turnkey/sdk-server";

const turnkeyClient = new Turnkey({
  apiBaseUrl: "https://api.turnkey.com",
  apiPublicKey: process.env.API_PUBLIC_KEY!,
  apiPrivateKey: process.env.API_PRIVATE_KEY!,
  defaultOrganizationId: process.env.ORGANIZATION_ID!,
});

const response = await turnkeyClient.apiClient().getApiKey({
  organizationId: "<string> (Unique identifier for a given organization.)",
  apiKeyId: "<string> (Unique identifier for a given API key.)"
});

200

{
  "apiKey": {
    "credential": {
      "publicKey": "<string>",
      "type": "<CREDENTIAL_TYPE_API_KEY_P256>",
      "sessionProfileId": "<string>"
    },
    "apiKeyId": "<string>",
    "apiKeyName": "<string>",
    "createdAt": {
      "seconds": "<string>",
      "nanos": "<string>"
    },
    "updatedAt": {
      "seconds": "<string>",
      "nanos": "<string>"
    },
    "expirationSeconds": "<string>"
  }
}