List Workspaces
List workspaces.
Use query parameters to filter the response. The orgId parameter can only be used by admin users of another organization (such as partners). The locationId, workspaceLocationId, indoorNavigation, floorId, capacity and type fields will only be present for workspaces that have a value set for them. The special values notSet (for filtering on category) and -1 (for filtering on capacity) can be used to filter for workspaces without a type and/or capacity.
Query Parameters
List workspaces in this organization. Only admin users of another organization (such as partners) may use this parameter.
Location associated with the workspace. Values must originate from the /locations API and not the legacy /workspaceLocations API.
Location associated with the workspace. Both values from the /locations API and the legacy /workspaceLocations API are supported. This field is deprecated and integrations should prefer locationId going forward.
Floor associated with the workspace.
List workspaces by display name.
List workspaces with the given capacity. Must be -1 or higher. A value of -1 lists workspaces with no capacity set.
List workspaces by type.
Offset. Default is 0.
Limit the maximum number of workspaces in the response.
List workspaces by calling type.
List workspaces by supported devices.
List workspaces by calendar type.
List workspaces enabled for device hosted meetings.
List workspaces by device platform.
List workspaces by health level.
Flag identifying whether to include the devices associated with the workspace in the response.
Response Properties
An array of workspace objects.
Unique identifier for the Workspace.
OrgId associated with the workspace.
Location associated with the workspace (ID to use for the /locations API).
Legacy workspace location ID associated with the workspace. Prefer locationId.
Floor associated with the workspace.
A friendly name for the workspace.
How many people the workspace is suitable for.
The workspace type.
No workspace type set.
High concentration.
Brainstorm/collaboration.
Dedicated meeting space.
Unstructured agile.
Individual.
Unspecified.
SipUrl to call all the devices associated with the workspace.
The date and time that the workspace was registered, in ISO8601 format.
Calling type.
Calling.
Free Calling.
Hybrid Calling.
Webex Calling.
Webex Edge For Devices.
Third-party SIP URI.
No Calling.
The hybridCalling object only applies when calling type is hybridCalling.
End user email address in Cisco Unified CM.
The webexCalling object only applies when calling type is webexCalling.
The Webex Calling license associated with this workspace.
Calendar type. Calendar of type none does not include an emailAddress field.
No calendar.
Google Calendar.
Microsoft Exchange or Office 365.
Workspace email address. Will not be set when the calendar type is none.
Notes associated to the workspace.
Hot desking status of the workspace.
Workspace supports hotdesking.
Workspace does not support hotdesking.
The supported devices for the workspace. Default is collaborationDevices.
Workspace supports collaboration devices.
Workspace supports MPP phones.
Calendar type. Calendar of type none does not include an emailAddress field.
No calendar.
Google Calendar.
Microsoft Exchange or Office 365.
Workspace email address. Will not be set when the calendar type is none.
Device hosted meetings configuration.
true if enabled or false otherwise.
The Webex site for the device hosting meetings.
The device platform.
Cisco.
Microsoft Teams Room.
Indoor navigation configuration.
URL of a map locating the workspace.
The health of the workspace.
Health level. The level is based on the list of issues associated with the workspace.
A list of workspace issues.
Issue id.
Issue created timestamp.
Issue title.
Issue description.
Recommended action to mitigate issue.
Issue level.
A list of devices associated with the workspace.
A unique identifier for the device.
A friendly name for the device.
The placeId field has been deprecated. Please use workspaceId instead.
The workspace associated with the device.
The person associated with the device.
The organization associated with the device.
The capabilities of the device.
The permissions the user has for this device. For example, xapi means this user is entitled to using the xapi against this device.
The connection status of the device.
The product name. A display friendly version of the device's model.
The product type.
Tags assigned to the device.
The current IP address of the device.
The current network connectivity for the device.
The unique address for the network adapter.
The primary SIP address to dial this device.
All SIP addresses to dial this device.
Serial number for the device.
The operating system name data and version tag.
The upgrade channel the device is assigned to.
The date and time that the device was registered, in ISO8601 format.
The location associated with the device.
The workspace location associated with the device. Deprecated, prefer locationId.
Error codes coming from the device.
Timestamp of the first time device sent a status post.
Timestamp of the last time device sent a status post.
Entity managing the device configuration.
The device platform.
Response Codes
The list below describes the common success and error responses you should expect from the API:
| Code | Status | Description |
|---|---|---|
| 200 | OK | Successful request with body content. |
| 201 | Created | The request has succeeded and has led to the creation of a resource. |
| 202 | Accepted | The request has been accepted for processing. |
| 204 | No Content | Successful request without body content. |
| 400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
| 401 | Unauthorized | Authentication credentials were missing or incorrect. |
| 403 | Forbidden | The request is understood, but it has been refused or access is not allowed. |
| 404 | Not Found | The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method. |
| 405 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. |
| 409 | Conflict | The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once. |
| 410 | Gone | The requested resource is no longer available. |
| 415 | Unsupported Media Type | The request was made to a resource without specifying a media type or used a media type that is not supported. |
| 423 | Locked | The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again. |
| 428 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded. |
| 429 | Too Many Requests | Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made. |
| 500 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. |
| 502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. |
| 503 | Service Unavailable | Server is overloaded with requests. Try again later. |
| 504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
Header
Query Parameters
- List workspaces in this organization. Only admin users of another organization (such as partners) may use this parameter.
- Location associated with the workspace. Values must originate from the /locations API and not the legacy /workspaceLocations API.
- Location associated with the workspace. Both values from the /locations API and the legacy /workspaceLocations API are supported. This field is deprecated and integrations should prefer `locationId` going forward.
- Floor associated with the workspace.
- List workspaces by display name.
- List workspaces with the given capacity. Must be -1 or higher. A value of -1 lists workspaces with no capacity set.
- List workspaces by type.
- Offset. Default is 0.
- Limit the maximum number of workspaces in the response.
- List workspaces by calling type.
- List workspaces by supported devices.
- List workspaces by calendar type.
- List workspaces enabled for device hosted meetings.
- List workspaces by device platform.
- List workspaces by health level.
- Flag identifying whether to include the devices associated with the workspace in the response.
{
"items": [
{
"id": "Y2lzY29zcGFyazovL3VzL1BMQUNFUy81MTAxQjA3Qi00RjhGLTRFRjctQjU2NS1EQjE5QzdCNzIzRjc",
"orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8xZWI2NWZkZi05NjQzLTQxN2YtOTk3NC1hZDcyY2FlMGUxMGY",
"locationId": "Y2lzY29...",
"workspaceLocationId": "YL34GrT...",
"floorId": "Y2lzY29z...",
"displayName": "SFO-12 Capanina",
"capacity": 5,
"type": "notSet",
"sipAddress": "test_workspace_1@trialorg.room.ciscospark.com",
"created": "2016-04-21T17:00:00.000Z",
"calling": {
"type": "hybridCalling",
"hybridCalling": {
"emailAddress": "workspace@example.com"
},
"webexCalling": {
"licenses": [
"Y2lzY29g4..."
]
}
},
"notes": "this is a note",
"hotdeskingStatus": "on",
"supportedDevices": "collaborationDevices",
"calendar": {
"type": "microsoft",
"emailAddress": "workspace@example.com"
},
"deviceHostedMeetings": {
"enabled": true,
"siteUrl": "'example.webex.com'"
},
"devicePlatform": "cisco",
"indoorNavigation": {},
"health": {
"level": "error",
"issues": [
{
"id": "",
"createdAt": "",
"title": "",
"description": "",
"recommendedAction": "",
"level": {
"Members": "error"
}
}
]
},
"devices": [
{
"id": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9ERVZJQ0UvNTEwMUIwN0ItNEY4Ri00RUY3LUI1NjUtREIxOUM3QjcyM0Y3",
"displayName": "SFO12-3-PanHandle",
"placeId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS83MTZlOWQxYy1jYTQ0LTRmZWQtOGZjYS05ZGY0YjRmNDE3ZjU",
"workspaceId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS83MTZlOWQxYy1jYTQ0LTRmZWQtOGZjYS05ZGY0YjRmNDE3ZjU",
"personId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS83MTZlOWQxYy1jYTQ0LTRmZWQtOGZjYS05ZGY0YjRmNDE3ZjU",
"orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"capabilities": [
{}
],
"permissions": [
{}
],
"connectionStatus": "connected",
"product": "Cisco Webex DX80",
"type": "roomdesk",
"tags": [
"First Tag",
"Second Tag"
],
"ip": "100.110.120.130",
"activeInterface": "wired",
"mac": "11:22:33:44:AA:FF",
"primarySipUrl": "sample_device@sample_workspacename.orgname.org",
"sipUrls": [
"sample_device@sample_workspacename.orgname.org",
"another_device@sample_workspacename.orgname.org"
],
"serial": "FOC1923NVVN",
"software": "RoomOS 2018-06-01 608dcdbb6e1",
"upgradeChannel": "beta",
"created": "2016-04-21T17:00:00.000Z",
"locationId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"workspaceLocationId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
"errorCodes": [
"sipprofileregistration"
],
"firstSeen": "2021-02-24T09:08:38.822Z",
"lastSeen": "2023-08-15T14:04:00.444Z",
"managedBy": "CISCO",
"devicePlatform": "cisco"
}
]
}
]
}