> This page is for Developer.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.makeswift.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.makeswift.com/_mcp/server.

# Get Page

GET https://api.makeswift.com/v6/pages/{pageIdOrPathname}

Returns a page by its ID or pathname.

Reference: https://docs.makeswift.com/developer/api-reference/rest/pages/get-page

## Authentication

- `x-api-key` header (required) — API key authentication. Accepts either: - App API key (e.g. sk_eczMHVBY9fV6GYFhvs53qcnxq7yptlXL3ABKOZtn6dQ) - Site API key (UUID format, e.g. 550e8400-e29b-41d4-a716-446655440000)

## Request

### Path parameters

- `pageIdOrPathname` (string, required) — The page ID or pathname for the page you are requesting.

### Query parameters

- `siteId` (string, optional) — The site ID required when using a pathname instead of a page ID.
- `versionRef` (enum, optional, default: ref:draft) — The version reference to retrieve the page from. Defaults to `ref:draft` if not provided. Supported formats: - `ref:draft` - Draft/working version - `ref:live` - Live/published version
  - Allowed values: `ref:live`, `ref:draft`
- `locale` (string, optional) — The locale to retrieve the page in. Accepts either a locale code (e.g. `en-US`) or a `site_locale` UUID. If provided and resolves to a non-default locale, localized page data is collapsed into the response.
- `include` (enum, optional) — Include additional data in the response. Omit for the page record alone. Supported values: - `elements` - include the 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: `elements`

## Response

### 200

- `object` (enum, required)
  - Allowed values: `page`
- `id` (string, required) — The ID of the page.
- `pathname` (string, required) — The page pathname.
- `canonicalUrl` (string, required, nullable) — The canonical URL of the page.
- `title` (string, required, nullable) — The page title.
- `description` (string, required, nullable) — The page description.
- `socialImageUrl` (string, required, nullable) — The social image URL of the page.
- `sitemapPriority` (double, required, nullable) — The sitemap priority.
- `sitemapFrequency` (enum, required, nullable) — The sitemap update frequency.
  - Allowed values: `always`, `hourly`, `daily`, `weekly`, `monthly`, `yearly`, `never`
- `createdAt` (datetime, required, nullable) — The page creation date and time.
- `updatedAt` (datetime, required, nullable) — The page last update date and time.
- `publishedAt` (datetime, required, nullable) — The page publication date and time.
- `isOnline` (boolean, required) — The flag that indicates whether the page is online.
- `excludedFromSearchEngines` (boolean, required, nullable) — The flag that indicates whether the page is excluded from search.
- `localizations` (list of GetPageV6ResponseBodyDtoLocalizationsItems, required) — The localizations of the page.
- `elements` (GetPageV6ResponseBodyDtoElements, required, nullable) — The root of the page's element tree. `null` unless `include=elements`.
- `locale` (string, optional) — The page locale. This defaults to the default locale of the parent site.

## Errors

### 403 Forbidden Error

Access forbidden.

- `any`

## Types

### GetPageV6ResponseBodyDtoLocalizationsItems

- `pathname` (string, required) — The pathname of the localization.
- `locale` (string, optional) — The locale of the localization.
- `id` (string, optional) — The ID of the localization.

### GetPageV6ResponseBodyDtoElements

The root of the page's element tree. `null` unless `include=elements`.

- `type` (enum, required)
  - Allowed values: `./components/Root/index.js`
- `key` (string, required) — A UUID, unique within this tree.
- `props` (map from string to any, required) — Control-defined values, keyed by prop name. Nested elements appear here too, as a \{ elements, columns } value that may sit under any prop name and at any depth - there is no reserved prop name for children.

## Examples

**Response**

```json
{
  "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"
}
```

**SDK Code**

```python
import requests

url = "https://api.makeswift.com/v6/pages/pageIdOrPathname"

headers = {"x-api-key": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.makeswift.com/v6/pages/pageIdOrPathname';
const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.makeswift.com/v6/pages/pageIdOrPathname"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.makeswift.com/v6/pages/pageIdOrPathname")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.makeswift.com/v6/pages/pageIdOrPathname")
  .header("x-api-key", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.makeswift.com/v6/pages/pageIdOrPathname', [
  'headers' => [
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.makeswift.com/v6/pages/pageIdOrPathname");
var request = new RestRequest(Method.GET);
request.AddHeader("x-api-key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["x-api-key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.makeswift.com/v6/pages/pageIdOrPathname")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```