API Documentation Overview
Learn how to navigate our API documentation site and access valuable resources for developing your projects efficiently and effectively.
Contact Us
If you still have questions or prefer to get help directly, please reach out to your technical contact.
Table of Contents
Are you needing your Maptician API authentication token? Please reach out to your Maptician technical contact for further assistance.
Welcome to Maptician's API Documentation Overview! This article serves as a starting point for understanding our API, which allows developers to seamlessly integrate with our platform and leverage its capabilities. Whether you're building a custom application or automating workflows, our API is designed to provide flexibility and control.
For further information, please visit our full API Guide.
Below are the currently supported Maptician APIs:
Reservations
-
Seat reservations
- GET /reservations/seats
-
Room reservations
- GET /reservations/rooms
-
Get Occupant Seat and Room Reservations
- GET /reservations/user/{userID}
-
Delete Occupant Seat and Room Reservations
- DELETE /reservations/user/{userID}
-
Create Seat Reservation
- POST /reservations/user/{userID}/seat/{seatID}
Occupants
-
Global Occupants List
- GET /occupants/global
-
Get Maptician Occupants
- GET /occupants
-
Create, Update, or Delete Maptician Occupants
- POST /occupants
-
Get Occupant's Delegation Permissions.
- GET /occupants/user/{userID}/delegates
-
Update Occupant's Delegation Permissions
- PUT /occupants/user/{userID}/delegates
Seats
-
Global Seat List
- GET /seats
-
Get Seat
- GET /seats/{seatID}
Seat Assignments
-
Get Seat Assignments
- GET /assignments/seats
-
Create Seat Assignment
- POST /assignments/seats
-
End Seat Assignment
- DELETE /assignments/seats/{assignmentID}
Locations
-
Global Locations List
- GET /locations/global
-
Create New Location
- POST /locations
-
Get Location
- GET /locations/location/{officeID}
-
Update Location
- PATCH /locations/location/{officeID}
-
Remove Location
- DELETE /locations/location/{officeID}
Prescreen Surveys
-
Completed Surveys
- GET /prescreen/completed_prescreen_surveys
Profile Images
-
Occupant's Profile Image
- GET /occupants/profile-images/{userID}
-
Set Occupant's Profile Image
- POST /occupants/profile-images/{userID}
-
Set Occupant's Profile Image (binary / multi-part form)
- POST /occupants/profile-images/{userID}/form-bin
-
Set Occupant's Profile Image (binary/body)
- POST /occupants/profile-images/{userID}/bin
-
Clear Occupant's Profile Image
- POST /occupants/profile-images/{userID}/clear
Authentication Tokens
-
Validate Token
- POST /auth/tokens/check
-
Create Token
- POST /auth/tokens/create
-
Revoke Token and Create a New One
- POST /auth/tokens/rotate
-
Revoke Token
- POST /auth/tokens/revoke
IP Address Access Events
-
Submit IP Access Event
- POST /ip/access_event
-
Submit Multiple IP Access Events
- POST /ip/access_events
Presence
-
Set Occupant Presence Status
- POST /presence/presence_entry
-
Set Multiple Maptician Presence Entries (start and end times)
- POST /presence/time_bounded
-
Set Multiple Maptician Presence Entries (start time only)
- POST /presence/entry_times
-
Set Multiple Maptician Presence Entries (date only)
- POST /presence/dates_only
-
Set Multiple "On Leave" Presence Entries
- POST /presence/leave_dates
-
Mark Present and Reserve Owned Seat
- POST /presence/present_and_reserve
Map Export
-
HTML map image
- GET /maps/{mapID}/html
-
SVG map image
- GET /maps/{mapID}/svg
-
PNG map image
- GET /maps/{mapID}/png
-
WEBP map image
- GET /maps/{mapID}/webp