• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

You are viewing an old version of the API
List locations

GET /v2/locations

Provides information of all locations of a business.

Many Square API endpoints require a location_id parameter. The id field of the Location objects returned by this endpoint correspond to that location_id parameter.


Permissions
MERCHANT_PROFILE_READ
Guide
Retrieve a list of locations
Try in API Explorer

Response Fields

Name Description
errors
Error [ ]

Any errors that occurred during the request.

locations
Location [ ]

The business locations.

Examples

You are viewing an old version of the API
GET /v2/locations
cURL
  • cURL
  • Ruby
  • Python
  • C#
  • Java
  • PHP
curl https://connect.squareup.com/v2/locations \
  -H 'Square-Version: 2020-09-23' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json'
Response JSON
{
  "locations": [
    {
      "id": "18YC4JDH91E1H",
      "name": "your location name",
      "address": {
        "address_line_1": "123 Main St",
        "locality": "San Francisco",
        "administrative_district_level_1": "CA",
        "postal_code": "94114",
        "country": "US"
      },
      "timezone": "America/Los_Angeles",
      "capabilities": [
        "CREDIT_CARD_PROCESSING"
      ],
      "status": "ACTIVE",
      "created_at": "2016-09-19T17:33:12Z",
      "merchant_id": "3MYCJG5GVYQ8Q",
      "country": "US",
      "language_code": "en-US",
      "currency": "USD",
      "phone_number": "+1 650-354-7217",
      "business_name": "Pumbaa's business name"
    }
  ]
}

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?