Get desks

get

https://api.envoy.com/v1/desks

Get a list of Desks.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

locationIds

array of objects

A comma-separated list of IDs. Allows lookup for multiple specific locations' desks at once. If left empty it will return all.

locationIds

floorIds

array of strings

Return Desks for specific floors by providing floorIds in a comma-seperated list.

floorIds

neighborhoodIds

array of strings

Return desks for specific neighborhoods by providing neighborhoodIds in a comma-seperated list.

neighborhoodIds

name

string

Filters results by searching for a case-insensitive match the desk's name.

startDate

string

deprecated

The start of the search period formatted as UTC date.

endDate

string

deprecated

The end of the search period formatted as UTC date.

page

number

Defaults to 1

Controls which page is returned in the results. Use with perPage.

perPage

number

Defaults to 250

Controls how many results to show in each page of the results. Use with page.

Response

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200