Pult Docs
ReferenceBookings

List bookings

Beta

GET
/bookings

Lists the bookings of a window of at most 31 days, sorted by date and stable within a date. Users with an active seat are included, archived users too; guests are not. A denied office request shows as a home booking, approved. Deleted and cancelled bookings no longer appear; re-read a recent window to see changes.

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' bookings.

Items1 <= items <= 50
groupId?string

Only bookings of users whose current group is this group.

officeId?string

Only office bookings at this office of your organization.

type?string

Only bookings of this type.

Value in"office""home""remote""coworking""business_trip""absent""vacation""sick"
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/bookings?startDate=2019-08-24&endDate=2019-08-24' \  -H 'Authorization: Bearer pult_<key>'
Example Response
{  "data": [    {      "id": "string",      "user": {        "id": "string",        "email": "string",        "firstName": "string",        "lastName": "string"      },      "date": "2019-08-24",      "period": "full_day",      "type": "office",      "category": "work",      "approvalStatus": "approved",      "office": {        "id": "string",        "name": "string"      }    }  ],  "pagination": {    "nextCursor": "string"  },  "meta": {    "startDate": "2019-08-24",    "endDate": "2019-08-24"  }}