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

You are viewing an old version of the API
List sites

GET /v2/sites

Lists the Square Online sites that belong to a seller.

Note: Square Online APIs are publicly available as part of an early access program. For more information, see Early access program for Square Online APIs.


Permissions
ONLINE_STORE_SITE_READ
Guide
List sites
Try in API Explorer

Response Fields

Name Description
errors
Error [ ]

Any errors that occurred during the request.

sites
Site [ ]

The sites that belong to the seller.

Examples

You are viewing an old version of the API
GET /v2/sites
cURL
  • cURL
  • Ruby
  • Python
  • C#
  • Java
  • PHP
  • Node.js
curl https://connect.squareup.com/v2/sites \
  -H 'Square-Version: 2021-07-21' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json'
Response JSON
{
  "sites": [
    {
      "id": "site_278075276488921835",
      "site_title": "My First Site",
      "domain": "mysite1.square.site",
      "is_published": true,
      "created_at": "2020-02-28T13:22:51Z",
      "updated_at": "2021-01-13T09:58:32Z"
    },
    {
      "id": "site_102725345836253849",
      "site_title": "My Second Site",
      "domain": "mysite2.square.site",
      "is_published": true,
      "created_at": "2020-06-18T17:45:13Z",
      "updated_at": "2020-11-23T02:19:10Z"
    }
  ]
}

Share feedback

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