Get a single Page

curl --request GET \
  --url https://api.buttercms.com/v2/pages/{page_type}/{page_slug}/ \
  --header 'Authorization: <api-key>'

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

fetch('https://api.buttercms.com/v2/pages/{page_type}/{page_slug}/', 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.buttercms.com/v2/pages/{page_type}/{page_slug}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <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.buttercms.com/v2/pages/{page_type}/{page_slug}/"

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

	req.Header.Add("Authorization", "<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.buttercms.com/v2/pages/{page_type}/{page_slug}/")

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

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

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

{
  "data": {
    "slug": "example-news-page",
    "name": "Example News Page",
    "page_type": "news",
    "published": "2019-11-12T17:23:53.109696Z",
    "updated": "2020-10-22T20:07:52.965850Z",
    "fields": {
      "seo": {
        "title": "Example News Page",
        "description": "SEO Description",
        "keywords": "SEO, Keywords"
      },
      "headline": "This is an example news page",
      "sections": [
        {
          "fields": {
            "headline": "...",
            "subheadline": "...",
            "call_to_action": "..."
          },
          "type": "hero"
        },
        {
          "fields": {
            "video_headline": "...",
            "video_link": "..."
          },
          "type": "product_video"
        }
      ]
    }
  }
}

GET

pages

{page_type}

{page_slug}

Get a single Page

curl --request GET \
  --url https://api.buttercms.com/v2/pages/{page_type}/{page_slug}/ \
  --header 'Authorization: <api-key>'

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

fetch('https://api.buttercms.com/v2/pages/{page_type}/{page_slug}/', 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.buttercms.com/v2/pages/{page_type}/{page_slug}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <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.buttercms.com/v2/pages/{page_type}/{page_slug}/"

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

	req.Header.Add("Authorization", "<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.buttercms.com/v2/pages/{page_type}/{page_slug}/")

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

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

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

{
  "data": {
    "slug": "example-news-page",
    "name": "Example News Page",
    "page_type": "news",
    "published": "2019-11-12T17:23:53.109696Z",
    "updated": "2020-10-22T20:07:52.965850Z",
    "fields": {
      "seo": {
        "title": "Example News Page",
        "description": "SEO Description",
        "keywords": "SEO, Keywords"
      },
      "headline": "This is an example news page",
      "sections": [
        {
          "fields": {
            "headline": "...",
            "subheadline": "...",
            "call_to_action": "..."
          },
          "type": "hero"
        },
        {
          "fields": {
            "video_headline": "...",
            "video_link": "..."
          },
          "type": "product_video"
        }
      ]
    }
  }
}

Retrieve a specific page by its page type and slug. This endpoint is ideal for fetching individual pages for display on your website or application. Page Type Flexibility: You can search across all page types using * as a wildcard, or optimize your query by providing a specific page type slug. Using the wildcard is useful when you know the page slug but aren’t certain of its type, while specifying the page type can improve query performance. Use dotted notation for field filters (e.g., fields.title=Example). See also: Architecture & Performance for guidance on levels, pagination, and performance best practices.

Authorizations

Authorization

string

header

required

Set the Authorization header to Token your_read_api_token.

Example: Authorization: Token abc123def456

Note: The header value includes the Token prefix.

You can access your API token from your settings page.

Path Parameters

page_type

string

required

The type of page to retrieve.

Use * to search across all page types
Use a specific page type slug to limit search to that type

page_slug

string

required

The slug of the page to retrieve.

Query Parameters

preview

enum<integer>

default:0

Set to 1 to return the latest draft version of a page. Useful for previewing changes before publishing live. i.e. &preview=1. If you are trying to view a scheduled page for which the most recent page version is published, you must pass the preview parameter to see the scheduled changes.

Set to 1 to access unpublished/draft collection items. Useful for staging environments.

Available options:

0,

1

locale

string

Set to the api slug of your configured locale (e.g. en or fr). When omitted, this query parameter will default to your organization's default locale.

Maximum string length: 10

Example:

"en"

levels

integer

default:2

Depth of relationship serialization.

Controls how many levels of referenced content to include:

1: Direct fields only, references as URIs
2: Direct fields + one level of references (default)
3-5: Deeper relationship traversal

Important: Higher levels increase response size. Maximum 10MB per response.

Valid range: 1-5 (inclusive). Values outside this range will be automatically capped.

Required range: 1 <= x <= 5

alt_media_text

enum<integer>

default:0

Media field response format.

Affects only media-typed fields. Other field types are unchanged.

0 (default): Media fields return simple URL strings
1: Media fields return objects with at least url and, when available, alt. If the stored media value is just a URL string, the object will include url only.

Available options:

0,

1

auth_token

string

Your ButterCMS read API token

Response

Success

A hash with a data property that contains the page matching the page slug.

data

object

A single page object that can be either a Single Page or Page Type page

Show child attributes

Overview

Read API

Write API

Webhooks API

Image API

Get a single Page

Authorizations

Path Parameters

Query Parameters

Response