/free-busy/spaces

Search space availability based on multiple parameters and get back results in a "Best Fit" order

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
👍

Use this endpoint to get multiple schedules

This is the best endpoint for fetching more than one space schedule at a time. It's been built with queries in mind, and will give the best performance for your app.

You must include either location_ids or space_ids in your request. Everything else is optional.

The free-busy endpoint is great for searching schedules between spaces, locations, and associated meta. If you see the word "filter" in a parameter above, it implies that non-matching results are omitted entirely, vs. just ordered lower in the results.

By default, this endpoint will filter out specialty (e.g kitchen) space types unless explicitly provided. You can manually override via the types param. Types returned by default are:

  • null (No space type assigned yet)
  • breakout
  • call
  • conference
  • meeting
  • office
  • study_room
Body Params
scope
object

The scope of the free busy search

filters
object

Used to filter our spaces within the scope based on various criteria.

view_options
object

Options that help shape the resulting view, such as the time bounds of the free/busy search and sub-resources that should be included in the result.

paging_info
object
Responses

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