Fetch API Key
GET {{endpoint}}/api-keys/:apiKey
Returns an API Key
This endpoint simply returns an API key without consuming it, it doesn't trigger webhook events on the key
Returns
200 if key was fetched successfully
401 if authentication fails
403 if user doesn't have any roles
404 if key doesn't exist
Note: You can fetch active keys only, if a key has been revoked (deleted), this route will return 404, but you can still fetch inactive keys by fetching all the Api keys using isActive=false filter, check Fetch API Keys
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
x-api-key | string |
RESPONSES
status: OK
{"key":"doc-api-custom-key-1","name":"Postman Docs API Key with all fields","customMetaData":{"accessType":"BASIC"},"customAccountId":"ACC123","customUserId":"USER123","env":"live","createdAt":"2022-08-23T14:32:40.223Z","updatedAt":"2022-08-23T14:32:40.223Z","isActive":true,"expiresAt":"2024-08-01T15:21:00.000Z","rateLimitConfigs":{"rateLimit":25,"rateLimitTtl":60}}