> ## Documentation Index
> Fetch the complete documentation index at: https://docs.brx.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# List API Keys

> Lists all API keys for the authenticated user

This endpoint lists all API keys for the authenticated user. It returns information about each API key, including its name, description, creation date, and access permissions. The actual API key values are not returned for security reasons.

## Request

This endpoint does not require any parameters.

### Example Request

```json theme={null}
{}
```

## Response

<ResponseField name="listKeyResponse" type="object">
  <Expandable title="properties">
    <ResponseField name="keys" type="array">
      Array of API key objects

      <Expandable title="items">
        <ResponseField name="name" type="string">
          The name of the API key
        </ResponseField>

        <ResponseField name="desc" type="string">
          The description of the API key
        </ResponseField>

        <ResponseField name="api_key" type="string">
          A masked version of the API key for display purposes
        </ResponseField>

        <ResponseField name="access_perms" type="string">
          The access permissions for the API key
        </ResponseField>

        <ResponseField name="createdAt" type="string">
          The creation date of the API key (ISO 8601 format)
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="total" type="number">
      Total number of API keys for the user
    </ResponseField>
  </Expandable>
</ResponseField>

### Example Response

```json theme={null}
{
  "listKeyResponse": {
    "keys": [
      {
        "name": "Production API Key",
        "desc": "Used for production server integration",
        "api_key": "brx_api_1234...abcdef",
        "access_perms": "read-only",
        "createdAt": "2023-01-01T00:00:00.000Z"
      },
      {
        "name": "Development API Key",
        "desc": "Used for development and testing",
        "api_key": "brx_api_5678...ghijkl",
        "access_perms": "read-write",
        "createdAt": "2023-01-02T00:00:00.000Z"
      }
    ],
    "total": 2
  }
}
```

### Example Response (No API Keys)

```json theme={null}
{
  "listKeyResponse": {
    "keys": [],
    "total": 0
  }
}
```

## Error Codes

<ResponseField name="401" type="object">
  Unauthorized - Authentication credentials are missing or invalid
</ResponseField>

<ResponseField name="500" type="object">
  Internal Server Error - An unexpected error occurred on the server
</ResponseField>

## Notes

* This endpoint returns information about all API keys for the authenticated user.
* The actual API key values are not returned for security reasons. Instead, a masked version of each API key is returned for display purposes.
* The `access_perms` field indicates the access permissions for the API key, such as "read-only" or "read-write".
* To generate a new API key, use the [Generate API Key](/api-reference/endpoint/generate-key) endpoint.
* To delete an API key, use the [Delete API Key](/api-reference/endpoint/delete-key) endpoint.