GEgetkisi
Presences

Fetch presences

Represents information about the presence of users in a place for a given date.

get/presences

Request

  • Base URL
    https://api.kisi.io
  • Auth
    • API key in header Authorization
    • or OAuth 2
      Authorization codehttps://api.kisi.io/oauth/authorize
      Token URLhttps://api.kisi.io/oauth/token
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Query parameters

limitinteger

The number of objects to return

offsetinteger

The number of objects to offset

place_idinteger required

The ID of the place to scope by

datestring date-time required

Filters the presences by date. In the place's time zone.

Response

OK

actor_typestring required

The actor type of the Presence

actor_idinteger required

The actor id of the Presence

actor_namestring required

The actor name of the Presence

actor_emailstring required

The actor email of the Presence

last_unlocked_lock_namestring required

The name of the lock that was unlocked last.

last_unlocked_lock_idinteger required

The ID of the lock that was unlocked last.

first_unlock_atstring date-time required

The date-time of the member's first unlock for the given date, in UTC.

last_unlock_atstring date-time required

The date-time of the member's last unlock for the given date, in UTC.

status'on_site' | 'inactive' | 'checked_out' | 'expired' required

The presence status of a user that was present or is currently present at the place on the given date.

place_idinteger required

The place ID of the presence

Changes

No recorded changes to this operation across all 13 revisions of this API.