API Keys

API Keys endpoints of the bizSupply API.

Last updated: 2026-07-21

GET /api/v1/api-keys

List all API keys for the authenticated user.

Responses

StatusDescription
200List of API key metadata (no plaintext)
401Authentication required

POST /api/v1/api-keys

Create a new API key.

The plaintext key is returned only once in the response. Save it immediately — it cannot be retrieved again.

Request body

  • application/jsonApiKeyCreateRequest

Responses

StatusDescription
201API key created
400Invalid request body
401Authentication required

GET /api/v1/api-keys/{id}

Get a specific API key by ID.

Parameters

NameInRequiredDescription
idpathyesAPI key UUID.

Responses

StatusDescription
200API key metadata
401Authentication required
404API key not found

DELETE /api/v1/api-keys/{id}

Revoke an API key.

Marks the key as REVOKED. It can no longer be used for authentication. This action cannot be undone.

Parameters

NameInRequiredDescription
idpathyesAPI key UUID to revoke.

Responses

StatusDescription
204API key revoked
401Authentication required
404API key not found