Seat Reservations

Retrieves a list of seat reservation events based on a provided time range and filter criteria.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum
required

Relative time range that determines retrieved reservations. If 'custom' is provided, the date range in 'start' and 'end' parameters will be used. If no value is provided but 'start' and 'end' parameters are present, the API will assume 'custom'. Options are case-insensitive and shown in camel case.

string
required

When using a 'custom' range, the 'start' parameter determines the start date. Can be formatted as 'YYYY-MM-DD' date string or Unix millisecond timestamp. Timestamp will reflect the start of the day containing the time value. Date will be determined based on reservation location's timezone. Using a date string ensures uniform date range, while a timestamp may result in varying date ranges across locations.

string
required

When using a 'custom' range, the 'end' parameter determines the end date. Can be formatted as 'YYYY-MM-DD' date string or Unix millisecond timestamp. Timestamp will reflect the end of the day containing the time value. Date will be determined based on reservation location's timezone. Using a date string ensures uniform date range, while a timestamp may result in varying date ranges across locations.

string

This parameter (which can also be entered as 'seat') determines seats/workstations for reservations to be queried. Can be single or multi-value. Multi-values can be entered as JSON arrays of seat identifier values or comma-separated values. If value contains/potentially contains a comma, provide as JSON array. Seat identifier can be seatID (uuid string) or the seat name in Maptician dashboard (case, punctuation, and spacing sensitive). Mixed lists of seatID and name values allowed, duplicates treated as single reference to the seat.

string

This parameter (which can also be entered as 'office') specifies the offices to retrieve reservations for. It can accept either single or multiple values. To provide multiple values, they can be formatted as a JSON array or be provided as a set of comma separated values.. If the office identifier contains or may contain commas, use the JSON array format. The identifier values can either be the officeID (a UUID string) or the name of the office as listed in Maptician. The names of the offices must match the names in Maptician and are case-insensitive but sensitive to punctuation and spacing. If the same location is referenced by multiple values, it will be treated as one reference.

string

This parameter (which can also be entered as 'map') specifies the maps to retrieve reservation information for. It can accept either a single value or multiple values in two formats - as a JSON array of map identifier values, or as a comma-separated list. If a map identifier value contains or might contain a comma, use the JSON array format. Map identifier values can be the map's ID (a UUID string) or the name of the map in Maptician. Map names are case-sensitive and must match the name in Maptician exactly. A mixed list of map IDs and names can be used, and duplicates will be treated as a single reference to the same map.

string

This parameter (which can also be entered as 'user') filters reservations to only include those 'owned' by the provided users. To be returned, a user must be the owner of the reservation, not just an attendee. This parameter can have either a single or multiple values. For multiple values, they can be entered as a JSON formatted array of user identifier values or as a set of comma separated values. If a user identifier value contains a comma, it should be provided as a JSON array. User identifier values can be the userID (a uuid string), name, or email of the user within Maptician. Names and emails are case and punctuation sensitive, emails are case insensitive. A mix of userID, name, and email values can be used, and values referring to the same user will be treated as a single reference.

string

This parameter (which can also be entered as 'attendee') filters reservations based on users who either own or attend them. Note - Use either this filter or the 'user' filter, but not both. The parameter can accept single or multiple values in the form of a JSON array or comma-separated values. If a value potentially contains a comma, it should be provided as a JSON array. Attendee identifier values can be a userID (a uuid string), the attendee's name as listed in Maptician (first/given last/family), or their email address within Maptician. Names are case, punctuation, and spacing sensitive, while emails are case insensitive. A mixed list of userID, name, and email can be used, and values referring to the same user will be treated as one reference to that attendee.

string
enum

The parameter determines the fields present in the returned reservation entries. :

  • The values of this parameter will determine the only fields returned for the reservations
  • Multi-Value: This parameter can be single or multi-value. Multi-value parameters can be entered as JSON formatted arrays of field values, or they can be provided as a set of comma separated values.
  • Sensitivity: Field names are case and punctuation sensitive.
  • Note: Only one of the field filters should be used - 'include' or 'exclude'.

string
enum

This parameter determines which fields are redacted from the returned reservation entries:

  • Values for this parameter will have their associated field redacted for all returned reservations, with all other fields in the object being present.
  • Multi-Value: This parameter can be single or multi-value. Multi-value parameters can be entered as JSON formatted arrays of field values, or they can be provided as a set of comma separated values.
  • Sensitivity: Field names are case and punctuation sensitive.
  • Note: Only one of the field filters should be used - 'include' or 'exclude'.

Headers
string
required

Authorization token to access the API.

Responses

401

Access token is missing or invalid

500

Unexpected Server Error

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json