Retrieve API Key

Beta

GET/v1/auth/api-keys/{id}

This endpoint is idempotent. Learn more

Returns API key metadata by ID.

idstring

API key ID.

include[]optional arrayenumValues:rolerole.permissions

Sub-objects to expand in the response. When omitted, sub-objects are returned as null.

idstring

API key ID.

objectstringenumValues:api_key

Resource type identifier.

namestring

Human-readable name for the API key.

redacted_valuestring

Redacted key value safe for display.

roleobjectExpandablenullable

Assigned role.

idstring

Role ID.

objectstringenumValues:role

Resource type identifier.

namestring

Display name.

typestringenumValues:adminuserscanner

Role type code.

The role's type is sometimes used to gate special behaviors in the frontend and to restrict some actions to only certain types of roles. For example, only roles with the type admin can create and manage API keys.

ownerobjectnullable

Owner of this resource.

Always returned as null in this endpoint.

permissionsarray of stringExpandablenullable

Permissions in {domain}:{action} format.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

last_used_atstring (date-time)nullable

Last used timestamp.

expires_atstring (date-time)nullable

Expiration timestamp.

revoked_atstring (date-time)nullable

Revocation timestamp.

Responses

200

Successful response for Retrieve API Key

Retrieve API Key

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const apiKey = await client.auth.apiKeys.retrieve('apke_01fba3a7db3996e3b3b1a07e00');

console.log(apiKey.id);

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const apiKey = await client.auth.apiKeys.retrieve('apke_01fba3a7db3996e3b3b1a07e00');

console.log(apiKey.id);

200 example

{
  "id": "apke_01fba3a7db3996e3b3b1a07e00",
  "object": "api_key",
  "name": "Production API Key",
  "redacted_value": "aug_sk_prod_****hjt4",
  "role": {
    "id": "rl_01c16d2eb637c0d1f3a372937c",
    "object": "role",
    "name": "Admin",
    "type": "admin",
    "owner": null,
    "permissions": [
      "customers:create",
      "customers:read",
      "customers:update",
      "customers:delete"
    ],
    "created_at": "2026-05-10T00:00:00Z",
    "updated_at": "2026-05-10T00:23:00Z"
  },
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z",
  "last_used_at": "2026-05-10T00:23:00Z",
  "expires_at": "2026-06-10T00:00:00Z"
}

{
  "id": "apke_01fba3a7db3996e3b3b1a07e00",
  "object": "api_key",
  "name": "Production API Key",
  "redacted_value": "aug_sk_prod_****hjt4",
  "role": {
    "id": "rl_01c16d2eb637c0d1f3a372937c",
    "object": "role",
    "name": "Admin",
    "type": "admin",
    "owner": null,
    "permissions": [
      "customers:create",
      "customers:read",
      "customers:update",
      "customers:delete"
    ],
    "created_at": "2026-05-10T00:00:00Z",
    "updated_at": "2026-05-10T00:23:00Z"
  },
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z",
  "last_used_at": "2026-05-10T00:23:00Z",
  "expires_at": "2026-06-10T00:00:00Z"
}

Retrieve API Key

Path Parameters

Query Parameters

Returns

Responses