Skip to main content
POST
/
api
/
v1
/
api-keys
/
{apiKeyId}
/
retrieve
Retrieve API Key
curl --request POST \
  --url https://api.example.com/api/v1/api-keys/{apiKeyId}/retrieve
{
  "secretKey": "VRTX.aBcDeFgHiJkL.1234567890abcdef",
  "id": "<string>",
  "name": "<string>",
  "lastRetrievedAt": "2023-11-07T05:31:56Z",
  "lastRetrievedBy": "<string>"
}

Path Parameters

​
apiKeyId
string
required

The unique identifier of the API key to retrieve

Example:

"decafbad-cafe-4dad-f00d-123456789abc"

Response

​
secretKey
string
required

The full API key with prefix (e.g., VRTX.xxx.yyy)

Example:

"VRTX.aBcDeFgHiJkL.1234567890abcdef"

​
id
string
required

The ID of the API key

​
name
string
required

Name of the API key

​
lastRetrievedAt
string<date-time>
required

When this key was last retrieved (updated each time)

​
lastRetrievedBy
string
required

UUID of the member who last retrieved this key