Workspaces - Get Workspace Details | Webex for Developers

Get Workspace Details

Shows details for a workspace, by ID. The workspaceLocationId, floorId, capacity, type and notes fields will only be present if they have been set for the workspace. Specify the workspace ID in the workspaceId parameter in the URI.

GET/v1/workspaces/{workspaceId}

URI Parameters

workspaceId

stringrequired

A unique identifier for the workspace.

Response Properties

string

Unique identifier for the Workspace.

orgId

string

OrgId associate with the workspace.

workspaceLocationId

string

Location associated with the workspace.

floorId

string

Floor associated with the workspace.

displayName

string

A friendly name for the workspace.

capacity

number

How many people the workspace is suitable for.

type

enum

The workspace type.

notSet

string

No workspace type set.

focus

string

High concentration.

huddle

string

Brainstorm/collaboration.

meetingRoom

string

Dedicated meeting space.

open

string

Unstructured agile.

desk

string

Individual.

other

string

Unspecified.

sipAddress

string

SipUrl to call all the devices associated with the workspace.

created

string

The date and time that the workspace was registered, in ISO8601 format.

calling

object

Calling type.

type

enum

Calling.

freeCalling

string

Free Calling.

hybridCalling

string

Hybrid Calling.

webexCalling

string

Webex Calling.

webexEdgeForDevices

string

Webex Edge For Devices.

hybridCalling

object

The hybridCalling object only applies when calling type is hybridCalling.

emailAddress

string

End user email address in Cisco Unified CM.

calendar

object

Calendar type. Calendar of type none does not include an emailAddress field.

type

enum

none

string

No calendar.

google

string

Google Calendar.

microsoft

string

Microsoft Exchange or Office 365.

emailAddress

string

Workspace email address. Will not be set when the calendar type is none.

notes

string

Notes associated to the workspace.

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.
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.

GET

/v1/workspaces/

Header

Authorization
Use personal access token
Bearer
This limited-duration personal access token is hidden for your security.

https://webexapis.com/v1/workspaces/Y2lzY29zcGFyazovL3VzL1BMQUNFUy81MTAxQjA3Qi00RjhGLTRFRjctQjU2NS1EQjE5QzdCNzIzRjc

200 / OK

{
  "id": "Y2lzY29zcGFyazovL3VzL1BMQUNFUy81MTAxQjA3Qi00RjhGLTRFRjctQjU2NS1EQjE5QzdCNzIzRjc",
  "orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8xZWI2NWZkZi05NjQzLTQxN2YtOTk3NC1hZDcyY2FlMGUxMGY",
  "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"
    }
  },
  "calendar": {
    "type": "microsoft",
    "emailAddress": "workspace@example.com"
  },
  "notes": "this is a note"
}