Retrieve location

GET

/v2/locations/{location_id}

Retrieves details of a single location.

Specify "main" as the location ID to retrieve details of the main location.

Permissions:MERCHANT_PROFILE_READ

Guide

Retrieve a specific location

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. Specify the string "main" to return the main location.

Link to section

Response fields

Link to section

errors

Information about errors encountered during the request.

Link to section

location

The requested location.

Link to section

Examples

GET /v2/locations/{location_id}

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

Response JSON

{
  "location": {
    "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"
  }
}