Skip to main content
GET
/
api-keys
List API keys
curl --request GET \
  --url https://api.coval.dev/v1/api-keys \
  --header 'X-API-Key: <api-key>'
import requests

url = "https://api.coval.dev/v1/api-keys"

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

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

print(response.text)
const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.coval.dev/v1/api-keys', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.coval.dev/v1/api-keys",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

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

func main() {

url := "https://api.coval.dev/v1/api-keys"

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

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

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.coval.dev/v1/api-keys")
.header("X-API-Key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.coval.dev/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"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "api_keys": [
    {
      "id": "01HX2ABC3DEF4GHI5JKL6MNO7P",
      "organization_id": "caf26438",
      "api_key": "****-****-****-o5p6",
      "key_type": "SERVICE",
      "status": "ACTIVE",
      "name": "Production Service Key",
      "description": "Primary key for production backend service authentication",
      "permissions": [],
      "create_time": "2025-10-14T12:00:00Z",
      "update_time": "2025-10-15T14:30:00Z",
      "last_used_at": "2025-10-16T09:15:00Z"
    },
    {
      "id": "01HX3DEF4GHI5JKL6MNO7PQR8S",
      "organization_id": "caf26438",
      "api_key": "****-****-****-q9r0",
      "key_type": "USER",
      "status": "ACTIVE",
      "name": "Staging Test Key",
      "description": "Key for staging environment testing",
      "permissions": [
        "runs:read",
        "runs:write"
      ],
      "create_time": "2025-10-13T08:00:00Z",
      "update_time": null,
      "last_used_at": "2025-10-14T11:45:00Z"
    }
  ],
  "next_page_token": "eyJvZmZzZXQiOjIwfQ==",
  "total_count": 42
}
{
"error": {
"code": "UNAUTHENTICATED",
"message": "Authentication failed",
"details": [
{
"field": "X-API-Key",
"description": "Invalid or missing API key"
}
]
}
}
{
"error": {
"code": "PERMISSION_DENIED",
"message": "Insufficient permissions",
"details": [
{
"field": "permissions",
"description": "API key does not have required permission: api-keys:write"
}
]
}
}
{
"error": {
"code": "INTERNAL",
"message": "Internal server error",
"details": [
{
"description": "An unexpected error occurred"
}
]
}
}

Authorizations

X-API-Key
string
header
required

API key for authentication

Query Parameters

status
string

Comma-separated list of statuses to filter by.

Supported values: ACTIVE, REVOKED, SUSPENDED, EXPIRED

If not provided, defaults to showing only ACTIVE keys.

page_size
integer
default:20

Maximum number of results per page

Required range: 1 <= x <= 100
page_token
string

Pagination token from previous response.

Response

API keys retrieved successfully

api_keys
object[]
required

List of API key resources (masked)

total_count
integer
required

Total number of API keys matching the filter criteria

Example:

42

next_page_token
string | null

Token for fetching next page (null if no more results)

Example:

"eyJvZmZzZXQiOjIwfQ=="