Checkins

Authenticated customers can use checkin service.

Get all customers' valid checkins for a site

GET /v1/companies/5678/sites/3232/checkins Get all Checkins

Get a customer's valid checkin

GET /v1/companies/5678/sites/3232/checkins/389427 Get a customer's Active Checkin
  • A customer can have no more than one valid checkin.
  • If the user requested is not checked in, you will receive a HTTP 404 with error message This customer is not checked in.

Create a Checkin

Creation of new checkin is currently limited to the fields below.

POST /v1/companies/5678/sites/3232/checkins Create a new customer
  • Only customer_id is required.
  • duration is set to 120 by default. You may specify the value of duration between 5 and 180.
  • Each customer should have only one valid checkin. If you try to create a checkin record for a customer who already checked in, you will have a HTTP 400 error.

Checkout (Delete a Checkin Record)

No Request Body Required to Checkout a Customer

DELETE /v1/companies/5678/sites/3232/checkins/389427 Checkout