Skip to main content
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>'
{
  "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"

​
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