> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.withverifa.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.withverifa.com/_mcp/server.

# List API keys

GET https://api.withverifa.com/api/v1/api-keys

Returns API keys for the authenticated organization. Secrets are never
returned — use the key prefix to identify keys.


Reference: https://docs.withverifa.com/api-reference/api-keys/list-api-keys

## Authentication

- `X-API-Key` header (required) — Organization API key. Keys are prefixed with `vk_live_` (production) or `vk_sandbox_` (sandbox).

## Request

### Query parameters

- `environment` (enum, optional) — Filter by environment.
  - Allowed values: `live`, `sandbox`
- `limit` (integer, optional, default: 50)
- `offset` (integer, optional, default: 0)

### Headers

- `Verifa-Version` (date, optional) — API version date string (e.g. `2026-02-01`). If omitted, the version pinned to your API key is used.

## Response

### 200

Paginated list of API keys.

- `data` (list of PublicApiKey, required)
- `pagination` (ApiV1ApiKeysGetResponsesContentApplicationJsonSchemaPagination, required)

## Errors

### 401 Unauthorized Error

Missing or invalid API key.

- `error` (string, required) — Short error code.
- `status_code` (integer, required) — HTTP status code.
- `detail` (string, optional) — Human-readable error description.

## Types

### PublicApiKey

API key details (secret is never included).

- `id` (string, required)
- `type` (enum, required)
  - Allowed values: `api-key`
- `environment` (enum, required)
  - Allowed values: `live`, `sandbox`
- `key_prefix` (string, required) — First characters of the key for identification.
- `is_active` (boolean, required)
- `created_at` (datetime, required)
- `label` (string, optional, nullable)
- `note` (string, optional, nullable)
- `scopes` (list of string, optional, nullable) — Permission scopes granted to this key.
- `api_version` (string, optional, nullable)
- `default_key_inflection` (enum, optional)
  - Allowed values: `camel`, `snake`, `kebab`
- `allowed_ips` (list of string, optional, nullable) — IP allowlist. Null means all IPs are allowed.
- `expires_at` (datetime, optional, nullable)
- `last_used_at` (datetime, optional, nullable)

### ApiV1ApiKeysGetResponsesContentApplicationJsonSchemaPagination

- `total` (integer, required) — Total number of matching items.
- `limit` (integer, required)
- `offset` (integer, required)

## Examples

**Response**

```json
{
  "data": [
    {
      "id": "key_abc123",
      "type": "api-key",
      "environment": "live",
      "key_prefix": "vk_live_abc1",
      "is_active": true,
      "created_at": "2024-01-15T09:30:00Z",
      "label": "string",
      "note": "string",
      "scopes": [
        "string"
      ],
      "api_version": "string",
      "default_key_inflection": "camel",
      "allowed_ips": [
        "string"
      ],
      "expires_at": "2024-01-15T09:30:00Z",
      "last_used_at": "2024-01-15T09:30:00Z"
    }
  ],
  "pagination": {
    "total": 1,
    "limit": 1,
    "offset": 1
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.withverifa.com/api/v1/api-keys"

headers = {"X-API-Key": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.withverifa.com/api/v1/api-keys';
const options = {method: 'GET', headers: {'X-API-Key': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.withverifa.com/api/v1/api-keys"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.withverifa.com/api/v1/api-keys")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.withverifa.com/api/v1/api-keys")
  .header("X-API-Key", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.withverifa.com/api/v1/api-keys', [
  'headers' => [
    'X-API-Key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.withverifa.com/api/v1/api-keys");
var request = new RestRequest(Method.GET);
request.AddHeader("X-API-Key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["X-API-Key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.withverifa.com/api/v1/api-keys")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```