Search Exchanges

get

https://www.keycafe.com/v0/exchange

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

Query Params

key

int64

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

user

int64

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

location

int64

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

type

string

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

before

date

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

after

date

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

completed

boolean

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

active

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

Response

Click Try It! to start a request and see the response here!