Sign in

v1

latestOpenAPI 3.0.02026-07-24161215397.4 KB
Checkins

Retrieve a single Check-In

Retrieve a single Check-In by checkinId.

Required scopes: flex.community.checkins.read

get/api/v2/organizations/{orgSlug}/checkins/{checkinId}

Path parameters

checkinIdstring required

check-in id

orgSlugstring required

organization slug

Response

_idstring

The _id of the check-in.

startstring date-time

Contains the start date of the check-in.

endstring date-time

Contains the end date of the check-in.

locationstring

The _id of the location associated with the check-in.

companystring

The _id of the company associated with the check-in.

memberstring

The _id of the member associated with the check-in.

bookingstring

The _id of the booking associated with the check-in.

passstring

The _id of the pass associated with the check-in.

resourceTypestring

The resourceType of the booking associated with the check-in.

sourcestring

The source associated with the check-in.

createdBystring

The user that created the check-in.

modifiedBystring

The user that did the last modification to the check-in. If no update is made this field will match the "createdBy" field.

Example response

{
  "_id": "6080186f490fcf6e0547ec57",
  "start": "2024-10-31T13:15:00.000Z",
  "end": "2024-10-31T15:30:00.000Z",
  "location": "6080186f490fcf6e0547ec57",
  "company": "6080186f490fcf6e0547ec57",
  "member": "6080186f490fcf6e0547ec57",
  "booking": "6080186f490fcf6e0547ec57",
  "pass": "6080186f490fcf6e0547ec57",
  "resourceType": "hotdesk",
  "source": "admin",
  "createdBy": "6080186f490fcf6e0547ec57",
  "modifiedBy": "6080186f490fcf6e0547ec57"
}