Locations with Locations - List Locations

List Locations

List locations for an organization.

Use query parameters to filter the result set by location name, ID, or organization.
Long result sets will be split into pages.
Searching and viewing locations in your organization requires an administrator or location administrator auth token with any of the following scopes: spark-admin:locations_read, spark-admin:people_read or spark-admin:device_read.

GET/v1/locations

Query Parameters

name

string

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

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: 500

Response Properties

items

array[Location]

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.

timeZone

string

Time zone associated with this location.

address

object

The address of the location.

address1

string

Address 1

address2

string

Address 2

city

string

City

state

string

State code

postalCode

string

ZIP/Postal Code

country

string

ISO-3166 2-Letter Country Code.

latitude

string

Latitude

longitude

string

Longitude

notes

string

Notes

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/locations{?name,id,orgId,max}

Header

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

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.

https://webexapis.com/v1/locations?name=Denver&id=Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2M5N2VlMDQ5LTM1OWItNGM3OC04NDU0LTA1OGMyZWRlMjU2Mw&orgId=Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE&max=100

200 / OK

    {
        "items": [
                {
                "id": "Y2lzY29zcGFyazovL3VzL0xPQ0FUSU9OL2M5N2VlMDQ5LTM1OWItNGM3OC04NDU0LTA1OGMyZWRlMjU2Mw",
                "name": "Denver",
                "orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi9hNDVkNmNkYS1hZTVhLTQwYzMtYTdhZC01NjUwZmRkZGQ1M2M",
                "address": {
                    "address1": "123 Some St.",
                    "address2": "Suite 456",
                    "city": "Supercity",
                    "state": "Goodstate",
                    "postalCode": "12345",
                    "country": "US"
                },
                "timeZone": "America/Chicago",
                "preferredLanguage": "en_us",
                "latitude": "12.935784",
                "longitude": "77.697332",
                "notes": "Suite 456 Denver location"
        }
        ]
    }