List locations

GET

/v2/locations

Provides details about all of the seller's locations, including those with an inactive status.

Locations are listed alphabetically by name.

Permissions:MERCHANT_PROFILE_READ

Guide

Retrieve a list of locations

Try in API Explorer

Link to section

Response fields

Link to section

errors

Any errors that occurred during the request.

Link to section

locations

The business locations.

Link to section

Examples

GET /v2/locations

curl https://connect.squareup.com/v2/locations \
  -H 'Square-Version: 2024-04-17' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json'

Response JSON

{
  "locations": [
    {
      "id": "18YC4JDH91E1H",
      "name": "Grant Park",
      "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": "Jet Fuel Coffee"
    },
    {
      "id": "3Z4V4WHQK64X9",
      "name": "Midtown",
      "address": {
        "address_line_1": "1234 Peachtree St. NE",
        "locality": "Atlanta",
        "administrative_district_level_1": "GA",
        "postal_code": "30309"
      },
      "timezone": "America/New_York",
      "capabilities": [
        "CREDIT_CARD_PROCESSING"
      ],
      "status": "ACTIVE",
      "created_at": "2022-02-19T17:58:25Z",
      "merchant_id": "3MYCJG5GVYQ8Q",
      "country": "US",
      "language_code": "en-US",
      "currency": "USD",
      "type": "PHYSICAL",
      "description": "Midtown Atlanta store",
      "coordinates": {
        "latitude": 33.7889,
        "longitude": -84.3841
      },
      "business_name": "Jet Fuel Coffee",
      "mcc": "7299"
    }
  ]
}