---
title: LocationsApi
---

## PureCloud::LocationsApi

All URIs are relative to *https://api.mypurecloud.com*

Method | HTTP request | Description
------------- | ------------- | -------------
|[**get_location_id**](LocationsApi.html#get_location_id) | **GET** /api/v2/locations/{locationId} | Get Location by ID.|
|[**get_locations**](LocationsApi.html#get_locations) | **GET** /api/v2/locations | Get the list of locations.|
{: class="table table-striped"}

<a name="get_location_id"></a>

## -[**Location**](Location.html) get_location_id(location_id)

Get Location by ID.



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::LocationsApi.new

location_id = "location_id_example" # String | Location ID


begin
  #Get Location by ID.
  result = api_instance.get_location_id(location_id)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling LocationsApi->get_location_id: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **location_id** | **String**| Location ID | 
{: class="table table-striped"}


### Return type

[**Location**](Location.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_locations"></a>

## -[**LocationEntityListing**](LocationEntityListing.html) get_locations(opts)

Get the list of locations.



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::LocationsApi.new

opts = { 
  state: "ACTIVE", # String | Location state
  name: "name_example", # String | Location name
  page_size: 25, # Integer | Page size
  page_number: 1 # Integer | Page number
}

begin
  #Get the list of locations.
  result = api_instance.get_locations(opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling LocationsApi->get_locations: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **state** | **String**| Location state | [optional] [default to ACTIVE]
 **name** | **String**| Location name | [optional] 
 **page_size** | **Integer**| Page size | [optional] [default to 25]
 **page_number** | **Integer**| Page number | [optional] [default to 1]
{: class="table table-striped"}


### Return type

[**LocationEntityListing**](LocationEntityListing.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json