Page Data Model

Pages in the current site.

This resource is a part of the Publishing Workflow.

Sample JSON Data 

      {
        "data": {
          "type": "pages",
          "id": "43a1b0e2-3d45-4e62-89ed-903f27565360",
          "attributes": {
            "page-type": "home",
            "slug": null,
            "path": "/",
            "title": "Simply Delicious Coffees",
            "description": "A meta description.",
            "keywords": "meta keywords coffee",
            "search-engine-indexable": true,
            "search-engine-followable": true,
            "canonical-url": null,
            "published-at": "2012-04-23T18:25:43.511Z",
            "trashed-at": "2012-04-23T18:25:43.511Z",
            "created-at": "2012-04-23T18:25:43.511Z",
            "updated-at": "2012-04-23T18:25:43.511Z"
          },
          "relationships": {
            "parent": {
              "data": {
                "type": "pages",
                "id": "7f4a35cd-b43c-4798-a8a2-6003ca2fbd1b"
              }
            },
            "layout": {
              "data": {
                "type": "layouts",
                "id": "cf07edd2-ec99-42dc-a76b-9ddf3699a22f"
              }
            },
            "draft": {
              "data": {
                "type": "drafts",
                "id": "6b34ed9d-3c59-46e3-871d-18faadb95dd8"
              }
            }
          }
        }
      }

Attributes

Attribute Type Required Description
page-type string No Type of page. Acceptable values are home, page, not_found, error, or search. All values except for page may only be used once per site.

If no other pages are entered, the default value is home. Otherwise, page is the default value.
slug string Yes Slug for this page to be appended to full URL path.
path string Read-only Site-root-relative URL path of page.
title string Yes Title to be used in the <title> tag.
description string No Description to be used in the <meta> description tag.
keywords string No List of keywords to be used in the <meta> keywords tag.
search-engine-indexable boolean Yes If set to true, will display a value of index in the robots <meta> tag. Otherwise, will display a value of nofollow.
search-engine-followable boolean Yes If set to true, will display a value of follow in the robots <meta> tag. Otherweise, will display a value of noindex.
canonical-url string No Value to display in a <link rel="canonical"> tag.
published-at date Read-only Timestamp recording when page was first published (null if never published), localized to the current logged in user’s time zone.
trashed-at date Read-only Timestamp recording when page was added to the trash (null if still active), localized to the current logged in user’s time zone.
created-at date Read-only Timestamp recording when page was created, localized to the current logged in user’s time zone.
updated-at date Read-only Date and time page record was last updated, localized to the current logged in user’s time zone.

Relationships

Title Type Required Description
parent object No Parent page in hierarchy. Required for pages that are not of type home, not_found, or error.
layout object Yes Page layout.
draft object Read-only Draft of page.

Related