Workspace Locations - List Workspace Locations

List Workspace Locations

The Workspace Locations API is deprecated and will be decommissioned November 30, 2024. Please use the /locations API for future projects, and use locationId instead of workspaceLocationId when interacting with device or workspace APIs.

List workspace locations. Use query parameters to filter the response. The orgId parameter can only be used by admin users of another organization (such as partners). The displayName, address, countryCode and cityName parameters are all optional. Requires an administrator auth token with the spark-admin:workspace_locations_read scope.

GET/v1/workspaceLocations

Query Parameters

orgId

string

List workspace locations in this organization. Only admin users of another organization (such as partners) may use this parameter.

displayName

string

Location display name.

address

string

Location address.

countryCode

string

Location country code (ISO 3166-1).

cityName

string

Location city name.

Response Properties

items

array[Location]

An array of location objects.

string

Unique identifier for the location.

locationId

string

The ID to use for this location in the /locations API

displayName

string

A friendly name for the location.

address

string

The location address.

countryCode

string

The location country code (ISO 3166-1).

cityName

string

The location city name.

latitude

number

The location latitude.

longitude

number

The location longitude.

notes

string

Notes associated with the location.

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.

GET

/v1/workspaceLocations{?orgId,displayName,address,countryCode,cityName}

Header

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

Query Parameters

orgId
string
List workspace locations in this organization. Only admin users of another organization (such as partners) may use this parameter.
displayName
string
Location display name.
address
string
Location address.
countryCode
string
Location country code (ISO 3166-1).
cityName
string
Location city name.

https://webexapis.com/v1/workspaceLocations?orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE&displayName=Cisco%20Barcelona&address=Carrer%20de%20Pere%20IV,%20Barcelona,%20Spain&countryCode=ES&cityName=Barcelona

200 / OK

{
  "items": [
    {
      "id": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9XT1JLU1BBQ0VfTE9DQVRJT04vM2E2ZmYzNzMtNjhhNy00NGU0LTkxZDYtYTI3NDYwZTBhYzVjIzUxOWY2N2E1LTlkOTktNGM2My04YTA5LWI5MTcxY2M2NmJkMQ==",
      "locationId": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzA2OWEzMDY2LTgwNjMtNDI0Zi05YmE0LTBhZDdhMmYxMzNjNQ",
      "displayName": "Cisco Barcelona",
      "address": "Carrer de Pere IV, Barcelona, Spain",
      "countryCode": "ES",
      "cityName": "Barcelona",
      "latitude": 41.406615,
      "longitude": 2.200717,
      "notes": "A note about the location"
    }
  ]
}