Developer centerv1.0.0
Documentation menu
API reference

List API key logs

Contract for GET /api/api-key-logs.

GET/api/api-key-logs

Tenant admins can list API key authentication and access records from their own institution.

Authentication

This endpoint requires a tenant admin Bearer JWT.

Parameters

FieldInTypeDescription
pagequeryintegerOne-based page number.
pageSizequeryintegerResults per page, capped by the API key policy.
dateFromquerystringStart date filter in ISO date format.
dateToquerystringEnd date filter in ISO date format.
successquerystringFilter successful or failed records.
errorTypequerystringFilter by API key access error type.
apiKeyIdquerystringFilter by API key id.

Responses

HTTPDescriptionSchema
200Successful responsePaginatedApiKeyLogs
400Invalid or missing request dataErrorResponse
401Authentication is missing or invalidErrorResponse
403Account, permission, source scope, domain or IP restriction failedErrorResponse
404Record not foundErrorResponse
500Server errorErrorResponse

Decision boundary

An API result is a candidate match. A final sanctions or compliance decision requires official-source verification and human review.