Get Seat Assignments

This endpoint retrieves a list of seat assignments based on selected filters like time range, office location, and others. You can specify various details such as which map or user details to include, and whether to exclude certain information. To lookup assignment(s) by their assignmentID, specify the assignmentID through the assignments parameter

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

Specifies the status of the seat assignments to retrieve. This parameter determines the timing of the seat assignments, with possible values being 'ongoing', 'scheduled', or 'ended'. The default value is 'ongoing'. When the 'assignments' parameter is used to query specific seat assignments, the 'assignmentStatus' parameter is not applicable and will be omitted from the results. Values are case-insensitive.

Allowed:
string

This parameter allows direct retrieval of seat assignments by specifying one or more assignment IDs. It can accept a single assignment ID or multiple IDs in two formats - as a JSON array of assignment identifier values, or as a comma-separated list. If an assignment ID potentially contains commas, use the JSON array format. Each assignment ID should be a unique identifier string (such as a UUID). If multiple IDs are provided, they will be treated as references to separate assignments. If assignments parameter is provided, the status field will not be used for querying seating assignments.

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
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

An unexpected error occurred on the server. Please try your request again later.

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