Skip to main content
GET
/
v2
/
api-keys
List API keys
curl --request GET \
  --url https://api.arize.com/v2/api-keys \
  --header 'Authorization: Bearer <token>'
{
  "api_keys": [
    {
      "id": "QXBp1001",
      "name": "My API Key",
      "description": "My API Key description",
      "key_type": "user",
      "status": "active",
      "redacted_key": "ak-xxx...yyy",
      "created_by_user_id": "Usr1001",
      "created_at": "2024-01-15T10:30:00Z",
      "expires_at": "2025-01-15T10:30:00Z"
    },
    {
      "id": "QXBp1002",
      "name": "My API Key 2",
      "description": "My API Key 2 description",
      "key_type": "service",
      "status": "active",
      "redacted_key": "ak-aaa...bbb",
      "created_by_user_id": "Usr1001",
      "created_at": "2024-01-10T08:00:00Z",
      "expires_at": "2025-01-10T08:00:00Z"
    }
  ],
  "pagination": {
    "next_cursor": "cursor_12345",
    "has_more": true
  }
}

Authorizations

Authorization
string
header
required

Most Arize AI endpoints require authentication. For those endpoints that require authentication, include your API key in the request header using the format

Query Parameters

key_type
enum<string>

Filter by API key type.

  • user - Key associated with a specific user.
  • service - Key associated with a bot user for service authentication.

Type of the API key.

  • user - Key associated with a specific user.
  • service - Key associated with a bot user for service authentication.
Available options:
user,
service
status
enum<string>

Filter by API key status.

  • active - Only return keys that are valid for use.
  • deleted - Only return keys that have been deleted.

When not specified, defaults to active.

Current status of the API key.

  • active - The key is valid for use.
  • revoked - The key has been revoked and is no longer valid.
Available options:
active,
revoked
space_id
string

Filter search results to a particular space ID A universally unique identifier (base64-encoded opaque string).

Example:

"RW50aXR5OjEyMzQ1"

user_id
string

Filter results by user (base64 global user ID). When provided, only records associated with this user are returned. Access requirements vary by endpoint — some endpoints restrict this filter to account admins.

A universally unique identifier (base64-encoded opaque string).

Example:

"RW50aXR5OjEyMzQ1"

limit
integer
default:50

Maximum items to return

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

Opaque pagination cursor returned from a previous response (pagination.next_cursor). Treat it as an unreadable token; do not attempt to parse or construct it.

Response

Returns a list of API keys matching the request filters. The raw key secret is never returned.

api_keys
object[]
required

API keys matching the request filters.

pagination
object
required

Pagination metadata for cursor-based navigation.