Retrieve location

GET

/v2/locations/{location_id}

Retrieves details of a location.

You can specify "main" as the location ID to retrieve details of the main location. For more information, see Locations API Overview.

Permissions:MERCHANT_PROFILE_READ

Try in API Explorer

Link to section

Path parameters

Example code

Link to section

location_id

string

Required

The ID of the location to retrieve. If you specify the string "main", then the endpoint returns the main location.

Link to section

Response fields

Link to section

errors

Information on errors encountered during the request.

Link to section

location

The requested location.

Link to section

Examples

All versions ->

GET /v2/locations/{location_id}

curl https://connect.squareup.com/v2/locations/18YC4JDH91E1H \
  -H 'Square-Version: 2020-07-22' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json'

Response JSON

{
  "location": {
    "id": "18YC4JDH91E1H",
    "name": "Jet Fuel Coffee - 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"
  }
}