Get Page - Makeswift Docs

Get Page

curl --request GET \
  --url https://api.makeswift.com/v6/pages/{pageIdOrPathname} \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.makeswift.com/v6/pages/{pageIdOrPathname}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.makeswift.com/v6/pages/{pageIdOrPathname}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

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", "<api-key>")

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

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

	fmt.Println(string(body))

}

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"] = '<api-key>'

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

{
  "object": "page",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "pathname": "furniture",
  "canonicalUrl": "<string>",
  "title": "<string>",
  "description": "<string>",
  "socialImageUrl": "<string>",
  "sitemapPriority": 0.5,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "publishedAt": "2023-11-07T05:31:56Z",
  "isOnline": true,
  "excludedFromSearchEngines": true,
  "localizations": [
    {
      "pathname": "<string>",
      "locale": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "locale": "<string>"
}

GET

/

v6

/

pages

/

{pageIdOrPathname}

Get Page

curl --request GET \
  --url https://api.makeswift.com/v6/pages/{pageIdOrPathname} \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.makeswift.com/v6/pages/{pageIdOrPathname}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.makeswift.com/v6/pages/{pageIdOrPathname}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

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", "<api-key>")

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

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

	fmt.Println(string(body))

}

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"] = '<api-key>'

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

{
  "object": "page",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "pathname": "furniture",
  "canonicalUrl": "<string>",
  "title": "<string>",
  "description": "<string>",
  "socialImageUrl": "<string>",
  "sitemapPriority": 0.5,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "publishedAt": "2023-11-07T05:31:56Z",
  "isOnline": true,
  "excludedFromSearchEngines": true,
  "localizations": [
    {
      "pathname": "<string>",
      "locale": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "locale": "<string>"
}

Authorizations

x-api-key

string

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)

Path Parameters

pageIdOrPathname

string

required

The page ID or pathname for the page you are requesting.

Query Parameters

siteId

string<uuid>

The site ID required when using a pathname instead of a page ID.

versionRef

enum<string>

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

Available options:

ref:live,

ref:draft

locale

string

The locale to retrieve the page in. If provided, localized page data is collapsed into the response.

Response

object

enum<string>

required

Available options:

page

Example:

"page"

id

string<uuid>

required

The ID of the page.

pathname

string

required

The page pathname.

Example:

"furniture"

canonicalUrl

string | null

required

The canonical URL of the page.

title

string | null

required

The page title.

description

string | null

required

The page description.

The social image URL of the page.

sitemapPriority

number | null

required

The sitemap priority.

Required range: 0 <= x <= 1

sitemapFrequency

enum<string> | null

required

The sitemap update frequency.

Available options:

always,

hourly,

daily,

weekly,

monthly,

yearly,

never

createdAt

string<date-time> | null

required

The page creation date and time.

updatedAt

string<date-time> | null

required

The page last update date and time.

publishedAt

string<date-time> | null

required

The page publication date and time.

isOnline

boolean

required

The flag that indicates whether the page is online.

excludedFromSearchEngines

boolean | null

required

The flag that indicates whether the page is excluded from search.

localizations

object[]

required

The localizations of the page.

Show child attributes

locale

string

The page locale. This defaults to the default locale of the parent site.