List Locations

List locations for an organization.

Use query parameters to filter the response.

Long result sets will be split into pages.

GET/v1/locations
Query Parameters
name
string

List locations whose name contains this string (case-insensitive).

id
string

List locations by ID.

orgId
string

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

max
number

Limit the maximum number of location in the response.

Default: 100
Response Properties
items
array
id
string

A unique identifier for the location.

name
string

The name of the location.

orgId
string

The ID of the organization to which this location belongs.

address
object

The address of the location.

address1
string

Address line 1

address2
string

Address line 2

city
string

City

state
string

State

postalCode
string

ZIP/Postal Code

country
string

Country

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.
  1. | 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/locations{?name,id,orgId,max}
Log in to try the API.
Header
Query Parameters
  • List locations whose name contains this string (case-insensitive).
  • List locations by ID.
  • List locations in this organization. Only admin users of another organization (such as partners) may use this parameter.
  • Limit the maximum number of location in the response.
https://webexapis.com/v1/locations?name=Denver&id=Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzUyOTA4Mg&orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE&max=100
200 / OK
{
  "items": [
    {
      "id": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OLzUyOTA4Mg",
      "name": "Denver",
      "orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
      "address": {
        "address1": "123 Some St.",
        "address2": "Suite 456",
        "city": "Supercity",
        "state": "Goodstate",
        "postalCode": "12345",
        "country": "US"
      }
    }
  ]
}