Skip to content

List Service Keys

GET
/internal/admin/service-keys

List all active service API keys.

Returns a paginated list of service account keys. Does not include revoked keys or plaintext/hash values for security.

Args: limit: Maximum number of keys to return (default 100, max 1000) offset: Pagination offset (default 0) admin_key: Validated admin API key (from dependency) db: Database session

Returns: List of ServiceKeyInfo objects

limit
Limit

Maximum keys to return

integer
default: 100 >= 1 <= 1000

Maximum keys to return

offset
Offset

Offset for pagination

integer
0

Offset for pagination

X-API-Key
Any of:
string

List of active service keys

Response List Service Keys Internal Admin Service Keys Get
Array<object>
ServiceKeyInfo

Service key information for listing (FR-LIST-002, FR-LIST-003, FR-LIST-004).

NOTE: Does not include key_hash or plaintext for security.

Attributes: id: Key UUID name: Key name created_at: Creation timestamp last_used_at: Last usage timestamp (if available) multi_tenant: Multi-tenant enabled permissions: Service permissions

object
id
required
Id

Key UUID

string
name
required
Name

Key name

string
created_at
required
Created At

Creation timestamp

string format: date-time
last_used_at
Any of:
string format: date-time
multi_tenant
required
Multi Tenant

Multi-tenant enabled

boolean
permissions
required
Permissions

Service permissions

Array<string>

Invalid API key

AdminAPIError

Standard error response for Admin API.

Attributes: error: Error code (e.g., ‘key_exists’, ‘permission_denied’) message: Human-readable error message

object
error
required
Error

Error code

string
message
required
Message

Human-readable error message

string

Missing admin:keys permission

AdminAPIError

Standard error response for Admin API.

Attributes: error: Error code (e.g., ‘key_exists’, ‘permission_denied’) message: Human-readable error message

object
error
required
Error

Error code

string
message
required
Message

Human-readable error message

string

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object

Rate limited

AdminAPIError

Standard error response for Admin API.

Attributes: error: Error code (e.g., ‘key_exists’, ‘permission_denied’) message: Human-readable error message

object
error
required
Error

Error code

string
message
required
Message

Human-readable error message

string