Get API keys

Get details about API keys for a user

POST

/

public

/

v1

/

query

/

get_api_keys

Authorizations

API Key

X-Stamp

string

header

required

Webauthn (Passkey)

X-Stamp-Webauthn

string

header

required

Body

organizationId · string · required

Unique identifier for a given Organization.

userId · string

Unique identifier for a given User.

Response

A successful response returns the following fields:

apiKeys · array · required

A list of API keys.

Show apiKeys details

apiKeys.credential

object

required

credential field

Show credential details

apiKeys.credential.publicKey

string

required

The public component of a cryptographic key pair used to sign messages and transactions.

apiKeys.credential.type

enum

required

type field

Enum options: CREDENTIAL_TYPE_WEBAUTHN_AUTHENTICATOR, CREDENTIAL_TYPE_API_KEY_P256, CREDENTIAL_TYPE_RECOVER_USER_KEY_P256, CREDENTIAL_TYPE_API_KEY_SECP256K1, CREDENTIAL_TYPE_EMAIL_AUTH_KEY_P256, CREDENTIAL_TYPE_API_KEY_ED25519, CREDENTIAL_TYPE_OTP_AUTH_KEY_P256, CREDENTIAL_TYPE_READ_WRITE_SESSION_KEY_P256, CREDENTIAL_TYPE_OAUTH_KEY_P256

apiKeys.apiKeyId

string

required

Unique identifier for a given API Key.

apiKeys.apiKeyName

string

required

Human-readable name for an API Key.

apiKeys.createdAt

object

required

createdAt field

Show createdAt details

apiKeys.createdAt.seconds

string

required

seconds field

apiKeys.createdAt.nanos

string

required

nanos field

apiKeys.updatedAt

object

required

updatedAt field

Show updatedAt details

apiKeys.updatedAt.seconds

string

required

seconds field

apiKeys.updatedAt.nanos

string

required

nanos field

apiKeys.expirationSeconds

string

Optional window (in seconds) indicating how long the API Key should last.

cURL

curl --request POST \
  --url https://api.turnkey.com/public/v1/query/get_api_keys \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <YOUR_API_KEY.YOUR_API_SECRET>" \
  --data '{
    "organizationId": "<string>",
    "userId": "<string>"
}'

200

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_UNKNOWN_V1",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "apiKeys": [
        {
          "credential": {
            "publicKey": "<string>",
            "type": "<CREDENTIAL_TYPE_WEBAUTHN_AUTHENTICATOR>"
          },
          "apiKeyId": "<string>",
          "apiKeyName": "<string>",
          "createdAt": {
            "seconds": "<string>",
            "nanos": "<string>"
          },
          "updatedAt": {
            "seconds": "<string>",
            "nanos": "<string>"
          },
          "expirationSeconds": "<string>"
        }
      ]
    }
  }
}