List API keys - Veryfront

veryfront__list_api_keys

Access

No external-service connection is required. Use a Veryfront credential with access to the requested resources. Call type: Can read or manage credentials.

Arguments

Field	Type	Required	Description and constraints
`cursor`	`string`	No	Opaque cursor pointing at the next page. Omit it to read the first page.
`limit`	`number`	No	Maximum number of entries to return. Defaults to 20 and is capped at 100. Default: `20`. Minimum: `1`. Maximum: `100`.
`project_reference`	`string`	No	Project ID or slug. Listing the keys bound to a project requires project.`api_keys`.read. Omit to list the caller’s own keys; a project-scoped API-key caller retains its enforced project when this field is omitted.
`status`	`string`	No	Which keys to list: active (the default), expired, revoked or all. Values: `"active"`, `"expired"`, `"revoked"`, `"all"`.
`sort_by`	`string`	No	Field to sort by. Defaults to `created_at`; ties break by key ID ascending. Default: `"created_at"`. Values: `"created_at"`, `"name"`, `"last_used_at"`.
`sort_order`	`string`	No	Sort direction. Defaults to desc. Default: `"desc"`. Values: `"asc"`, `"desc"`.

Example request

Send this JSON-RPC request through an initialized MCP client. Replace sample identifiers and values before calling the tool. See MCP client setup.

request.json

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "veryfront__list_api_keys",
    "arguments": {}
  }
}

Result

The published output shape is summarized below. Inspect both the MCP response content and isError when handling a call.

Field	Type	Required	Description and constraints
`data`	`object[]`	Yes	Primary result records returned by the tool.
`page_info`	`object`	Yes	Pagination cursor values for traversing the result set.

Full schemas

{
  "type": "object",
  "properties": {
    "cursor": {
      "type": "string",
      "description": "Opaque cursor pointing at the next page. Omit it to read the first page."
    },
    "limit": {
      "type": "number",
      "minimum": 1,
      "maximum": 100,
      "description": "Maximum number of entries to return. Defaults to 20 and is capped at 100.",
      "default": 20
    },
    "project_reference": {
      "type": "string",
      "description": "Project ID or slug. Listing the keys bound to a project requires project.api_keys.read. Omit to list the caller's own keys; a project-scoped API-key caller retains its enforced project when this field is omitted."
    },
    "status": {
      "type": "string",
      "enum": [
        "active",
        "expired",
        "revoked",
        "all"
      ],
      "description": "Which keys to list: active (the default), expired, revoked or all."
    },
    "sort_by": {
      "type": "string",
      "enum": [
        "created_at",
        "name",
        "last_used_at"
      ],
      "description": "Field to sort by. Defaults to created_at; ties break by key ID ascending.",
      "default": "created_at"
    },
    "sort_order": {
      "type": "string",
      "enum": [
        "asc",
        "desc"
      ],
      "description": "Sort direction. Defaults to desc.",
      "default": "desc"
    }
  },
  "additionalProperties": false,
  "description": "Arguments for the list_api_keys tool.",
  "$schema": "http://json-schema.org/draft-07/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"
          },
          "name": {
            "type": "string",
            "description": "Human-readable name for the returned record."
          },
          "key_prefix": {
            "type": "string"
          },
          "last_used_at": {
            "type": [
              "string",
              "null"
            ]
          },
          "expires_at": {
            "type": [
              "string",
              "null"
            ]
          },
          "created_at": {
            "type": "string",
            "description": "Creation timestamp in ISO 8601 format."
          },
          "updated_at": {
            "type": "string",
            "description": "Last update timestamp in ISO 8601 format."
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "expired",
              "revoked"
            ],
            "description": "Whether the key can authenticate. A revoked key stays listed with status revoked."
          },
          "revoked_at": {
            "type": [
              "string",
              "null"
            ],
            "description": "When the key was revoked; null while it is not revoked."
          },
          "scopes": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "List of scopes associated with this tool result."
          },
          "scope": {
            "type": "string",
            "enum": [
              "account",
              "project"
            ],
            "description": "Whether the key is bound to one project (project) or applies to the account (account)."
          }
        },
        "required": [
          "id",
          "project_id",
          "user_id",
          "name",
          "key_prefix",
          "last_used_at",
          "expires_at",
          "created_at",
          "updated_at",
          "status",
          "revoked_at",
          "scopes",
          "scope"
        ],
        "additionalProperties": false
      },
      "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": "null"
        },
        "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#"
}