List Retriever API Keys

List all API keys for this retriever.

Fields:

• key_id: Public identifier for the key
• key_prefix: First 10 characters + ”…” for identification (e.g., “ret_sk_abc…”)
• name: Human-friendly label
• created_at: When the key was created
• last_used_at: When the key was last used (if ever)
• status: ACTIVE, REVOKED, or EXPIRED
• expires_at: Expiration timestamp (if set)

Note:

• Plaintext key is NEVER returned in list responses
• Only shown once in creation response
• Use key_prefix to identify keys in the UI

GET /v1/retrievers/{retriever_id}/api-keys

List Retriever API Keys

cURL

curl --request GET \
  --url https://api.mixpeek.com/v1/retrievers/{retriever_id}/api-keys \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Namespace: <api-key>'

200

{
  "results": [
    {
      "key_hash": "<string>",
      "internal_id": "<string>",
      "user_id": "<string>",
      "name": "<string>",
      "key_id": "<string>",
      "key_prefix": "sk_abc123...",
      "key_type": "standard",
      "subscription_id": "<string>",
      "is_internal": false,
      "organization_id": "<string>",
      "description": "",
      "permissions": [],
      "scopes": [
        {
          "resource_id": "<string>",
          "operations": []
        }
      ],
      "rate_limit_override": 123,
      "status": "active",
      "expires_at": "2023-11-07T05:31:56Z",
      "last_used_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": "<string>",
      "revoked_at": "2023-11-07T05:31:56Z",
      "revoked_by": "<string>",
      "allowed_origins": [
        "https://docs.example.com",
        "https://*.example.com"
      ],
      "principal_id": "<string>"
    }
  ],
  "total": 0
}

Authorizations

Authorization · string · header · required

Mixpeek API key, sent as Authorization: Bearer mxp_sk_.... Create one in Studio under Settings → API Keys, or with an admin key via POST /v1/organizations/users/{user_email}/api-keys. A missing header returns 403; an invalid or revoked key returns 401.

X-Namespace · string · header · required

Namespace id (ns_...), not the namespace name. This scopes the request rather than authenticating it, and it is required on every operation marked x-mixpeek-namespace-scoped.

Path Parameters

retriever_id · string · required

Query Parameters

include_revoked · boolean · default: false

Include revoked and expired keys in the response

Response

200

application/json

Successful Response

Response for listing retriever API keys.

results · APIKeyModel · object[]

List of API keys for the retriever (plaintext key never included).

Show child attributes

total · integer · default: 0

Total number of keys (including revoked if requested).