Skip to main content
The V3 API Keys endpoints let you manage keys programmatically - listing, creating, and revoking keys - by authenticating with an existing API key (X-Api-Key). You can also create and manage keys in the Snappy dashboard on the Sharing & Access page.
For the full authentication concept guide - including how scopes work, how to use mTLS, and best practices for key rotation - see Snappy API Authentication: API Keys, Scopes & mTLS.
The V2 API Keys endpoints offer the same list, create, and delete operations using V2 conventions.

​
The API Key Object

The V3 response shape never includes the secret value, even on creation responses. Treat the secret as opaque once issued.

​
Key Concepts

​
Maximum 100 active keys per Company

Companies can have up to 100 active API keys at any time.

​
Page-number pagination

The List endpoint uses page-number pagination (page[number], page[size]), with the standard V3 links envelope (first, next, prev).

​
Standard V3 error envelope

Errors follow the standard V3 shape: { message, errorCode, errors[] } with structured error codes (e.g. 403_PBLC_001) and dot-separated paths to field-level errors.

​
How to Work with API Keys (V3)

List API keys
Returns a paginated list of the active API keys for your Company. Filter by Account access scope, paginate with page[number] / page[size]. Create an API key
Creates a new API key. The secret value is returned in this response only. Delete an API key
Permanently deletes the specified key. Returns 204 No Content on success.
Last modified on June 30, 2026