List API Keys

Beta

GET/v1/auth/api-keys

This endpoint is idempotent. Learn more

Returns a paginated list of API keys.

cursoroptional string

Cursor token used to retrieve the next or previous page of results.

limitoptional integer

Maximum number of results per page (default: 100, max: 1000).

qoptional string

Search query used to filter results.

statuses[]optional arrayenumValues:activeexpiredrevoked

API key statuses to filter by.

include[]optional arrayenumValues:rolerole.permissions

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

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

URL to fetch the next page, null if no more pages.

previous_page_urlstringnullable

URL to fetch the previous page, null if on the first page.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of object

Resources in this page.

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 List API Keys

List API Keys

import Augno from '@augno/sdk';

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

const listAPIKey = await client.auth.apiKeys.list();

console.log(listAPIKey.data);

import Augno from '@augno/sdk';

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

const listAPIKey = await client.auth.apiKeys.list();

console.log(listAPIKey.data);

200 example

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/auth/api-keys?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJpIjo5MDAwMDAwMDAwMDAwMDAxLCJkIjoiZiJ9.r5XugPZFb0OtO_khu04X0V5O97iX0bsgP10NkJPtXas",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "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"
    }
  ]
}

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/auth/api-keys?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJpIjo5MDAwMDAwMDAwMDAwMDAxLCJkIjoiZiJ9.r5XugPZFb0OtO_khu04X0V5O97iX0bsgP10NkJPtXas",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "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"
    }
  ]
}

List API Keys

Query Parameters

Returns

Responses