Get Site Page

Retrieves a page from a Square Online site using the page ID.

GET /v2/sites/{site_id}/pages/{page_id}

Permissions: ONLINE_STORE_CUSTOM_THEME_READ

Path parameters

Name Type Description
site_id string Required The ID of the site.
page_id string Required The ID of the page to retrieve.

Response fields

Name Type Description
errors Error [ ] Any errors that occurred during the request.
page SitePage The requested page.

Example request

curl https://connect.squareup.com/v2/sites/site_id0/pages/page_id1 \
  -H 'Square-Version: 2023-09-25' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json'

Example response

{
  "page": {
    "id": "site_page_7e4e68a8-fde2-11ee-be56-0242ac120002",
    "name": "Home",
    "route": "lightning-home",
    "properties": "{\"props\": {\"main\": [{\"props\": {\"heading\": \"Featured products\", \"products\": {\"filters\": {\"ids\": [\"164\", \"165\", \"166\", \"167\", \"168\", \"169\"], \"square_online_id\": true}}}, \"template\": \"featured\"}], \"footer\": {\"props\": []}, \"header\": {\"props\": []}}, \"layout\": \"layouts/brisk\", \"template\": \"templates/pages/home\"}",
    "site_id": "site_278075276488921835",
    "created_at": "2020-06-18T17:45:13.000000Z",
    "updated_at": "2020-11-23T02:19:10.000000Z"
  }
}