Makeswift Docs

{
  "object": "list",
  "data": [
    {
      "object": "page",
      "id": "string",
      "pathname": "furniture",
      "canonicalUrl": "string",
      "title": "string",
      "description": "string",
      "socialImageUrl": "string",
      "sitemapPriority": 0.5,
      "sitemapFrequency": "always",
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "publishedAt": "2024-01-15T09:30:00Z",
      "isOnline": true,
      "excludedFromSearchEngines": true,
      "localizations": [
        {
          "pathname": "string",
          "locale": "string",
          "id": "string"
        }
      ],
      "elements": {
        "type": "./components/Root/index.js",
        "key": "4e1a7c3b-2d9f-4b6e-8a5c-7f0d1e2b3c4a",
        "props": {
          "children": {
            "@@makeswift/type": "prop-controllers::grid::v1",
            "value": {
              "columns": [
                {
                  "deviceId": "desktop",
                  "value": {
                    "count": 12,
                    "spans": [
                      [
                        12
                      ]
                    ]
                  }
                }
              ],
              "elements": [
                {
                  "key": "9c2b5e7d-1a4f-4c8b-b3e6-0d7f2a1c9e8b",
                  "props": {
                    "label": {
                      "@@makeswift/type": "prop-controllers::margin::v1",
                      "value": [
                        {
                          "deviceId": "desktop",
                          "value": {
                            "marginBottom": {
                              "unit": "px",
                              "value": 0
                            },
                            "marginLeft": "auto",
                            "marginRight": "auto",
                            "marginTop": {
                              "unit": "px",
                              "value": 0
                            }
                          }
                        }
                      ]
                    }
                  },
                  "type": "./components/Button/index.js"
                }
              ]
            }
          }
        }
      },
      "locale": "string"
    }
  ],
  "hasMore": true
}

Returns a list of pages for a site.

Authentication

x-api-keystring

API key authentication with an App API key (e.g. sk_eczMHVBY9fV6GYFhvs53qcnxq7yptlXL3ABKOZtn6dQ).

x-api-keystring

Site API key (UUID format, e.g. 550e8400-e29b-41d4-a716-446655440000).

Query parameters

siteIdstringRequiredformat: "uuid"

The site ID to list pages from.

limitdoubleOptional1-100Defaults to 20

The maximum number of pages to return.

startingAfterstringOptionalformat: "uuid"

The pagination cursor. This is used to indicate what ID to list from.

pathPrefixstringOptionalDefaults to /

The filter that limits pages to only those with a pathname that begins with this value.

sortByenumOptionalDefaults to path

The field to sort pages by.

Allowed values:

sortDirectionenumOptionalDefaults to asc

The sort direction.

Allowed values:

includeOfflineenumOptionalDefaults to false

The flag that determines whether to include offline pages in the results.

Allowed values:

localestringOptional

The locale code to filter pages by.

versionRefenumOptionalDefaults to ref:draft

The version reference to retrieve pages from. Defaults to ref:draft if not provided.

Supported formats:

ref:draft - Draft/working version
ref:live - Live/published version

Allowed values:

includeenumOptional

Include additional data in the response. Omit for the page record alone.

Supported values:

elements - include each page’s element tree. This feature is in beta and may change. Requests return 403 until the feature flag is enabled for your site or workspace.

Allowed values:

Response

objectenum

Allowed values:

datalist of objects

hasMoreboolean

The flag that indicates whether there are more pages available.

Errors

403

Forbidden Error