Get keys
GET/keys
Gets paginated list of keys. The endpoint uses page based pagination.
Keys can be filtered by optional parameters: operatorId, assetId, siteId, groupId, customerId, description, companyName, accessType,
keyTargetType, statuses, showDeleted, showExpired, showScheduled, and showActive.
The time-window flags (showDeleted, showExpired, showScheduled, showActive) filter separately from statuses: they classify keys purely by
their validity window, whereas statuses reflects whether deployment to the underlying assets has actually completed. For example, if
PIN removal is still in progress after a key has been deleted, statuses will report IN_PROGRESS rather than DELETED.
showFuture is a deprecated alias for showScheduled, kept for backward compatibility.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 500
A list of keys.
Bad request
Invalid or missing bearer token in Authorization header
User not allowed to make this request
Resource not found
Internal server error