Jump to Content
API Reference
v2.0
Log In
API Reference
Log In
v2.0
API Reference
Creates a new inventory session.
JUMP TO
Keyper API
AccessTime
Retrieves the access time details for a specific ID.
get
Updates the details of a specific access time entry.
put
Creates a new access time entry.
post
Deletes multiple access time entries by their IDs.
del
Asset
Retrieves an asset by its ID.
get
Deletes an asset by its ID.
del
Updates an asset by its ID.
put
Retrieves assets by a list of IDs.
get
Retrieves assets by user ID.
get
Retrieves an asset by its FOB tag.
get
Retrieves an asset by its FOB serial number.
get
Retrieves assets by user access group ID with filtering options.
get
Retrieves a spare key asset by parent asset ID.
get
Retrieves all assets with filtering options.
get
Creates a new asset.
post
Deletes assets by a list of IDs.
del
Attaches a FOB to an asset.
post
Detaches a FOB from an asset.
post
AssetLog
Retrieves an asset log entry by its ID.
get
Retrieves all asset log entries with filtering options.
get
AssetTransaction
Retrieves an asset transaction by its ID.
get
Retrieves a list of asset transactions by their IDs.
get
Retrieves all asset transactions with filtering options.
get
AttributeCollection
Retrieves all attribute collections with filtering options. Attribute collections include fields related to each asset, such as year, make, and model.
get
Attributes
Retrieves the details of a specific asset attribute by its ID.
get
Retrieves all asset attributes with filtering options.
get
Authentication
Authenticates a user and generates a JWT token.
post
Refreshes a JWT token using an expired token and a refresh token.
post
Fob
Retrieves a fob by its ID.
get
Retrieves a list of fobs by their IDs.
get
Retrieves a list of fobs by their fob numbers.
get
Retrieves all fobs with filtering options.
get
Retrieves all unattached fobs with filtering options.
get
HealthCheck
Endpoint to perform a health check.
get
InventorySession
Retrieves an inventory session by its ID.
get
Deletes an inventory session by its ID.
del
Retrieves inventory sessions by user ID.
get
Retrieves inventory sessions by a list of IDs.
get
Retrieves all inventory sessions with optional filtering.
get
Creates a new inventory session.
post
Sets an inventory session as finished by its ID.
post
InventorySessionScan
Retrieves an inventory session scan by its ID.
get
Deletes an inventory session scan by its ID.
del
Retrieves an inventory session scan by inventory session ID and scanned value.
get
Retrieves all inventory session scans with optional filtering.
get
Creates a new inventory session scan.
post
First attempts to update an inventory session scan pre-generated from the initial inventory session creation. If an inventory session scan does not match the request's ScannedValue, a new inventory session scan is created.
put
Retrieves all inventory session scans by inventory session ID.
get
IssueReason
Retrieves an issue reason by its ID.
get
Retrieves all issue reasons with optional filtering.
get
LotLocation
Retrieves a lot location by its ID.
get
Retrieves a list of lot locations by their IDs.
get
Retrieves all lot locations with optional filtering.
get
ParkingSpace
Retrieves a parking space by its ID.
get
Retrieves a list of parking spaces by their IDs.
get
Retrieves all parking spaces with optional filtering.
get
ProcessStep
Retrieves a process step by its ID.
get
Retrieves a list of process steps by their IDs.
get
Retrieves all process steps with optional filtering.
get
Reservation
Retrieves a reservation by its ID.
get
Deletes a reservation by its ID.
del
Updates a reservation by its ID.
put
Retrieves a list of reservations by user ID.
get
Retrieves a list of reservations by their IDs.
get
Retrieves all reservations with optional filtering.
get
Creates a new reservation.
post
Creates a quick reservation for an asset.
post
ReservationAsset
Retrieves assets by reservation ID.
get
SocketMap
Retrieves all socket maps by cabinet ID.
get
System
Retrieves a system by its ID.
get
Retrieves systems by user access group ID.
get
Retrieves systems by a list of IDs.
get
Retrieves all systems with pagination.
get
User
Retrieves a user by its ID.
get
Deletes a user by its ID.
del
Updates a user by its ID.
put
Retrieves users by a list of IDs.
get
Retrieves all users with pagination.
get
Creates a new user.
post
Retrieves users by user access group ID.
get
Retrieves a user by external ID.
get
Deletes users by a list of IDs.
del
Changes the password for a user.
post
UserAccessGroup
Retrieves all user access groups with pagination.
get
Creates a new user access group.
post
Retrieves a user access group by its ID.
get
Deletes a user access group by its ID.
del
Updates a user access group by its ID.
put
Retrieves user access groups by user ID.
get
Retrieves user access groups by a list of IDs.
get
Deletes user access groups by a list of IDs.
del
Assigns users to a user access group.
put
Unassigns users from a user access group.
put
Assigns assets to a user access group.
put
Unassigns assets from a user access group.
put
Assigns systems to a user access group.
put
Unassigns systems from a user access group.
put
Assigns cabinets to a user access group.
put
Unassigns cabinets from a user access group.
put
Powered by
Creates a new inventory session.
Ask AI
post
https://example.com/CustomerName/api/v2/InventorySession
Language
Shell
Node
Ruby
PHP
Python
Credentials
http
http
