AXaxilioai
api-keys

List API keys

Changed on

Lists the API keys for the caller's organization. Filter by search (name or key preview), created_by_id and a created_after/created_before window; order with order_by ('<field> <asc|desc>'), field one of name, created_by_id, created_at or last_used_at. Defaults to created_at desc.

get/api-keys

Request

Query parameters

limitinteger

max items per page

offsetinteger

pagination offset

searchstring

only keys whose name or key preview contains this text

created_by_idstring[] nullable

only keys created by one of these users; repeatable

created_afterstring date-time

only keys created at or after this time (RFC 3339)

created_beforestring date-time

only keys created at or before this time (RFC 3339)

order_bystring

Sort expression '<field> [asc|desc]', direction defaulting to desc; field is name, created_by_id, created_at or last_used_at. Defaults to created_at desc.

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

limitinteger required

Page size used for this response.

offsetinteger required

Pagination offset used for this response.

totalinteger required

Total number of API keys for the organization.

Example response

{
  "$schema": "/api/v1/APIKeyListResponse.json"
}

Changes

  • 80de09d0e643Revision changes
    • info

      added the required property // to the response with the status

  • 49b1da5a7974Revision changes
    • info

      added the new optional query request parameter created_after

    • info

      added the new optional query request parameter created_before

    • info

      added the new optional query request parameter created_by_id

    • info

      added the new optional query request parameter order_by

    • info

      added the new optional query request parameter search

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status