get

/pages/{id}

Returns a Page.

Authorization

apiKey - X-Auth-Token
apiKey - X-Auth-Client

Request Parameters

1 Path Parameter
2 Headers

Responses

1 Example
Schema
object
id
integer

ID of the page.

1 validation
parent_id
integer

ID of any parent Web page.

1 validation
type
string

page: free-text page
link: link to another web address
rss_feed: syndicated content from an RSS feed
contact_form: When the store’s contact form is used.

1 validation + required
contact_fields
string

Where the page’s type is a contact form: object whose members are the fields enabled (in the control panel) for storefront display. Possible members are:fullname: full name of the customer submitting the form; phone: customer’s phone number, as submitted on the form; companyname: customer’s submitted company name; orderno: customer’s submitted order number; rma: customer’s submitted RMA (Return Merchandise Authorization) number.

1 validation
email
string

Where the page’s type is a contact form: email address that receives messages sent via the form.

1 validation
name
string

Page name, as displayed on the storefront.

1 validation + required
url
string

Relative URL on the storefront for this page.

1 validation
meta_description
string

Description contained within this page’s <meta/> element.

body
string

HTML or variable that populates this page’s <body> element, in default/desktop view. Required in POST if page type is raw.

1 validation + required
mobile_body
string

HTML to use for this page’s body when viewed in the mobile template (deprecated).

1 validation
has_mobile_version
boolean

If true, this page has a mobile version.

1 validation
is_visible
boolean

If true, this page appears in the storefront’s navigation menu.

1 validation
is_homepage
boolean

If true, this page is the storefront’s home page.

1 validation
meta_title
string

Text specified for this page’s <title> element. (If empty, the value of the name property is used.)

layout_file
string

Layout template for this page. This field is writable only for stores with a Blueprint theme applied.

1 validation
sort_order
integer

Order in which this page should display on the storefront. (Lower integers specify earlier display.)

1 validation
search_keywords
string

Comma-separated list of keywords that shoppers can use to locate this page when searching the store.

meta_keywords
string

Comma-separated list of SEO-relevant keywords to include in the page’s <meta/> element.

feed
string

If page type is rss_feed the n this field is visisble. Required in POST required for rss page type.

required
link
string

If page type is link this field is returned. Required in POST to create a link page.

required
content_type
string
2 validations

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
id
$$.env
2 variables not set
store_hash
X-Auth-Token
X-Auth-Client