Test Environment. You are currently using the Webex for Developers test environment. Apps created here will not be available for use with Webex Teams. Please visit Webex for Developers to manage your apps.

List Places

List places.

Use query parameters to filter the response.

GET/v1/places
Query Parameters
displayName
string

List places by display name.

orgId
string

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

max
number

Limit the maximum number of places in the response.

Response Properties
items
array

An array of place objects.

id
string

Unique identifier for the Place.

displayName
string

A friendly name for the place.

orgId
string

OrgId associate with the place

sipAddress
string

SipUrl to call all the devices associated with the place.

created
string

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

Response Codes

The list below describes the common success and error responses you should expect from the API.

CodeStatusDescription
200OKSuccessful request with body content.
204No ContentSuccessful request without body content.
400Bad RequestThe request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401UnauthorizedAuthentication credentials were missing or incorrect.
403ForbiddenThe request is understood, but it has been refused or access is not allowed.
404Not FoundThe 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.
405Method Not AllowedThe request was made to a resource using an HTTP request method that is not supported.
409ConflictThe 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.
415Unsupported Media TypeThe request was made to a resource without specifying a media type or used a media type that is not supported.
429Too Many RequestsToo 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.
500Internal Server ErrorSomething went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502Bad GatewayThe server received an invalid response from an upstream server while processing the request. Try again later.
503Service UnavailableServer is overloaded with requests. Try again later.
GET
/v1/places{?displayName,orgId,type,max}
Log in to try the API.
Header
Query Parameters
  • List places by display name.
  • List places in this organization. Only admin users of another organization (such as partners) may use this parameter.
  • Limit the maximum number of places in the response.
https://api.ciscospark.com/v1/places?displayName=SFO-12%20Capanina&orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE&max=100
{
  "items": [
    {
      "id": "Y2lzY29zcGFyazovL3VzL1BMQUNFUy81MTAxQjA3Qi00RjhGLTRFRjctQjU2NS1EQjE5QzdCNzIzRjc",
      "displayName": "SFO-12 Capanina",
      "orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8xZWI2NWZkZi05NjQzLTQxN2YtOTk3NC1hZDcyY2FlMGUxMGY",
      "sipAddress": "test_place_1@trialorg.room.ciscospark.com",
      "created": "2016-04-21T17:00:00.000Z"
    }
  ]
}