Pult Docs
ReferencePresence

List presence days

Beta

GET
/presence-days

Lists one row per person, day and presence location for a window of at most 31 days, sorted by date, user and presence location. Users with an active seat are included, archived users too; guests are not. firstSeenAt and lastSeenAt are first and last detected, never working hours. History is removed by a daily job after your organization's presence retention period, so data up to about a day past it can still appear; past days can change.

Authorization

headerAuthorizationBearer <pult_<base62>>

An API key created by an admin of your organization in the Pult dashboard, sent as Authorization: Bearer <key>. Keys start with pult_.

Query Parameters

startDate*string

The window's first day, inclusive (YYYY-MM-DD).

Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
Formatdate
endDate*string

The window's last day, inclusive (YYYY-MM-DD); the window spans at most 31 days, both ends counted.

Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$
Formatdate
userId?array<>

Repeatable. Only these users.

Items1 <= items <= 50
groupId?string

Only users whose current group is this group.

presenceLocationId?string

Only this presence location.

cursor?string

Opaque cursor from pagination.nextCursor of the previous page; omit it for the first page.

Length1 <= length
limit?integer

Page size, 1 to 500; default 100.

Range1 <= value <= 500
Default100

Response Body

OK

application/json
  1. response
data*array<>
pagination*

Cursor pagination: nextCursor is null on the last page.

meta*
Example Request
curl -X GET 'https://api.pult.com/v1beta/presence-days?startDate=2019-08-24&endDate=2019-08-24' \  -H 'Authorization: Bearer pult_<key>'
Example Response
{  "data": [    {      "user": {        "id": "string",        "email": "string",        "firstName": "string",        "lastName": "string"      },      "date": "2019-08-24",      "presenceLocation": {        "id": "string",        "name": "string"      },      "firstSeenAt": "2019-08-24T14:15:22Z",      "lastSeenAt": "2019-08-24T14:15:22Z",      "detectionMethods": [        "wifi"      ]    }  ],  "pagination": {    "nextCursor": "string"  },  "meta": {    "startDate": "2019-08-24",    "endDate": "2019-08-24",    "timeZone": "string"  }}