Search Exchanges

Retrieve data for multiple exchanges with a GET request to the endpoint.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
🚧

Exchange API Deprecation Notice

The Exchange API is a realtime authentication method that requires the cloud and connectivity to be fully intact during the key exchange. This module predates and by its nature cannot support our offline key exchange capability. With Offline Mode, the MS5 and MS4 SmartBoxes can continue operating even when connectivity is lost or the cloud is disrupted by reverting to their last synced state, enhancing reliability and ensuring a seamless key exchange experience. Thus, we strongly encourage using Accesses and Permissions for development which sync with the SmartBox in advance of the key exchange. A seamless user experience can be implemented by presenting a QR code for the user to present at the SmartBox.

For more details on Offline Mode, visit our help center.

Pagination

Results are paginated, with a maximum of 50 exchanges per page. Additional pages can be accessed using the Link response header

Link: <https://www.keycafe.com/v0/exchange?key=123456&page=2>; rel="next",
      <https://www.keycafe.com/v0/exchange?key=123456&page=2>; rel="last"
  • rel="first": URL to retrieve the first page of results.
  • rel="prev": URL to retrieve the previous page of results.
  • rel="next": URL to retrieve the next page of results.
  • rel="last": URL to retrieve the final page of results.
Query Params
int64

The unique identifier of a key by which to filter results.
Example: 123456

int64

The unique identifier of a user by which to filter results.
Example: 123456

int64

The unique identifier of a location by which to filter results.

string

The exchange type (PICKUP/DROPOFF/ACTIVATION) by which to filter results.

date

The latest possible date by which to filter results, in ISO 8601 format without milliseconds.

date

The earliest possible date by which to filter results, in ISO 8601 format without milliseconds.

boolean

If true, results will be limited to completed exchanges. If false, to incomplete exchanges.

boolean

If true, results will be limited to exchanges that are currently in progress. An exchange will time out if not completed within 20 seconds of a bin release being authorized, or within 30 seconds of a fob bin being released during an activation.

Responses
200

Success

400

Invalid ID supplied

404

ID not found

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here!