Skip to main content
List API keys for the authenticated user or a specific project

Tool details

FieldValue
Namelist_api_keys
GroupAPI Keys

Playground

Input schema

Input schema
{
  "type": "object",
  "properties": {
    "project_reference": {
      "type": "string",
      "description": "Project ID or slug (optional, if not provided lists all user keys)"
    },
    "limit": {
      "type": "number",
      "minimum": 1,
      "maximum": 100,
      "description": "Number of results per page",
      "default": 20
    },
    "cursor": {
      "type": "string",
      "description": "Pagination cursor from previous response"
    }
  },
  "additionalProperties": false,
  "description": "Input schema for the list_api_keys tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Output schema

Output schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier for the returned record."
          },
          "project_id": {
            "type": [
              "string",
              "null"
            ],
            "description": "Project identifier associated with this result."
          },
          "user_id": {
            "type": "string",
            "description": "The user id associated with this tool result."
          },
          "name": {
            "type": "string",
            "description": "Human-readable name for the returned record."
          },
          "key_prefix": {
            "type": "string",
            "description": "The key prefix associated with this tool result."
          },
          "last_used_at": {
            "type": [
              "string",
              "null"
            ],
            "description": "The last used at associated with this tool result."
          },
          "expires_at": {
            "type": [
              "string",
              "null"
            ],
            "description": "The expires at associated with this tool result."
          },
          "created_at": {
            "type": "string",
            "description": "Creation timestamp in ISO 8601 format."
          },
          "updated_at": {
            "type": "string",
            "description": "Last update timestamp in ISO 8601 format."
          },
          "scopes": {
            "type": "array",
            "items": {
              "type": "string",
              "description": "One scope item associated with this tool result."
            },
            "description": "List of scopes associated with this tool result."
          }
        },
        "required": [
          "id",
          "project_id",
          "user_id",
          "name",
          "key_prefix",
          "last_used_at",
          "expires_at",
          "created_at",
          "updated_at",
          "scopes"
        ],
        "additionalProperties": false,
        "description": "One data item associated with this tool result."
      },
      "description": "Primary result records returned by the tool."
    },
    "page_info": {
      "type": "object",
      "properties": {
        "self": {
          "type": [
            "string",
            "null"
          ],
          "description": "Cursor that refers to the current page."
        },
        "first": {
          "type": "object",
          "description": "The first associated with this tool result."
        },
        "next": {
          "type": [
            "string",
            "null"
          ],
          "description": "Cursor for the next page when pagination is available."
        },
        "prev": {
          "type": [
            "string",
            "null"
          ],
          "description": "Cursor for the previous page when pagination is available."
        }
      },
      "required": [
        "self",
        "first",
        "next",
        "prev"
      ],
      "additionalProperties": false,
      "description": "Pagination cursor values for traversing the result set."
    }
  },
  "required": [
    "data",
    "page_info"
  ],
  "additionalProperties": false,
  "description": "Structured result returned by the list_api_keys tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}