List workspaces
GET {{baseUrl}}/workspaces?location_id=<string>&page_size=30&next_page_token=<string>
Use this API to list a location's workspaces.
Scopes: workspace:readworkspace:read:admin
Rate Limit Label: MEDIUM
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
location_id | string | (Required) The location's ID. | |
page_size | number | The number of records returned within a single API call. | |
next_page_token | string | Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"next_page_token":"\u003cstring\u003e","page_size":30,"total_records":"\u003cinteger\u003e","workspaces":[{"id":"\u003cstring\u003e","workspace_name":"\u003cstring\u003e","workspace_type":"desk","location_id":"\u003cstring\u003e"},{"id":"\u003cstring\u003e","workspace_name":"\u003cstring\u003e","workspace_type":"room","location_id":"\u003cstring\u003e"}]}