Contents

# SquareConnect::LocationApi

All URIs are relative to *https://connect.squareup.com*

Method | HTTP request | Description
------------- | ------------- | -------------
[**list_locations**](LocationApi.md#list_locations) | **GET** /v2/locations | ListLocations


# **list_locations**
> ListLocationsResponse list_locations(authorization)

ListLocations

Provides the details for all of a business's locations.  Most other Connect API endpoints have a required `location_id` path parameter. The `id` field of the [`Location`](#type-location) objects returned by this endpoint correspond to that `location_id` parameter.

### Example
```ruby
# load the gem
require 'square_connect'

api_instance = SquareConnect::LocationApi.new

authorization = "authorization_example" # String | The value to provide in the Authorization header of your request. This value should follow the format `Bearer YOUR_ACCESS_TOKEN_HERE`.


begin
  #ListLocations
  result = api_instance.list_locations(authorization)
  p result
rescue SquareConnect::ApiError => e
  puts "Exception when calling LocationApi->list_locations: #{e}"
end
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **authorization** | **String**| The value to provide in the Authorization header of your request. This value should follow the format `Bearer YOUR_ACCESS_TOKEN_HERE`. | 

### Return type

[**ListLocationsResponse**](ListLocationsResponse.md)

### Authorization

No authorization required

### HTTP request headers

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

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
square_connect-2.0.2.69	docs/LocationApi.md
square_connect-2.0.2.30	docs/LocationApi.md
square_connect-2.0.2.13	docs/LocationApi.md