Sign in

v1

latestOpenAPI 3.0.02026-07-24161215397.4 KB
Checkins

Retrieve all check-ins.

Retrieve all check-ins.

Required scopes: flex.community.checkins.read

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

Path parameters

orgSlugstring required

organization slug

Query parameters

_idstring
Example:6080186f490fcf6e0547ec57

Filter by the _id of the check-in.

companystring
Example:6080186f490fcf6e0547ec58

Filter by the company associated with the check-in.

memberstring
Example:6080186f490fcf6e0547ec58

Filter by the company associated with the check-in.

locationstring
Example:6080186f490fcf6e0547ec59

Filter by the location associated with the check-in.

sourcestring
Example:admin

Filter by the source associated with the check-in.

startstring
Example:start[$gte]=2024-10-31T13:00:00Z

Support date comparison filters: $gt, $gte, $lt, $lte

endstring
Example:end[$gte]=2024-10-31T13:00:00Z

Support date comparison filters: $gt, $gte, $lt, $lte

createdAtstring date-time
Example:?createdAt[$gte]=2024-02-01

Support date comparison filters: $gt, $gte, $lt, $lte

$selectstring
Example:recipient,sender

Select fields to return

$cursorNextstring
$cursorPrevstring
$limitnumber

Response

rangeStartnumber
rangeEndnumber
cursorNextstring
cursorPrevstring

Example response

{
  "results": [
    {
      "_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"
    }
  ]
}