Sign in
Pages

Get Pages

get/v1/pages

Query parameters

parent_idstring
ignore_parent_idboolean
search_stringstring
limitinteger

A limit on the number of objects to be returned

A limit on the number of objects to be returned

offsetinteger

The number of objects to skip

The number of objects to skip

typesstring

Optional comma separated list of types

Optional comma separated list of types

Response

Successful Response

keystring

External unique page identifier

titlestring required

The title of the page

textstring required
descriptionstring required

The description of the page

slugstring required

The slug of the page

htmlstring

The HTML content of the page

type'content' | 'article' | 'news' | 'collection' | 'blocks'
webhook_idstring nullable

The page.get webhook serving the layout. A filled value makes the layout come from the webhook instead of the stored blocks.

parent_idstring nullable

The ID of the parent page

datestring date nullable
datetimeinteger nullable

The date of the page

featured_image_urlstring uri nullable

The URL of the featured image for the page

pinned_image_urlstring uri nullable

The URL of the pinned image for the page

pinned_webview_image_urlstring uri nullable

The URL of the pinned image for the page (in webview)

published_atinteger nullable

The published date of the Page

positioninteger nullable

The position of the page in the page list

video_urlstring uri nullable

The URL of the video for the page

is_featuredboolean nullable

Whether the page is featured

is_pinnedboolean nullable

Whether the page is pinned

pin_scope'global' | 'collection'

How far a pinned article or page reaches.

  • global: the pin also acts on views spanning sibling collections
  • collection: the pin acts only among the articles of its own collection

An unset scope is read as GLOBAL.

tagsstring[] nullable

Tags for the page

custom_urlstring uri nullable

Custom URL that the page card links to instead of the page itself

button_textstring nullable

Text for the page card button

idstring required
layout_source'static' | 'webhook' required

Changes

Changed in 9 of the 28 revisions of this API.81230

  • 1816e2044c0744See the full diff
    • ●

      added the new function enum value to the ///////////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new function enum value to the ////////////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new function enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new function enum value to the //// response property for the response status

      response-property-enum-value-added

    • ○

      added the optional property /////////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property //////////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • dd5e5e9f81ef24See the full diff
    • ▲

      added to the //// response property oneOf list for the response status

      response-property-one-of-added

    • ▲

      added to the ///// response property oneOf list for the response status

      response-property-one-of-added

    • ○

      added to the ////////// response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added to the /////////// response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added FeaturedArticleBlock discriminator mapping keys to the //// response property for the response status

      response-property-discriminator-mapping-added

    • ○

      added FeaturedArticleBlock discriminator mapping keys to the ///// response property for the response status

      response-property-discriminator-mapping-added

  • fb9750c99d0a4See the full diff
    • ●

      for the query request parameter limit, the exclusiveMinimum was set to 1.00

      request-parameter-exclusive-min-set

    • ●

      for the query request parameter parent_id, the maxLength was set to 32

      request-parameter-max-length-set

    • ●

      for the query request parameter limit, the max was set to 300.00

      request-parameter-max-set

    • ●

      for the query request parameter offset, the min was set to 0.00

      request-parameter-min-set

  • 5e18ab6733324See the full diff
    • ●

      added the new wiki enum value to the ////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new wiki enum value to the //////////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new wiki enum value to the /////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new wiki enum value to the ///////////// response property for the response status

      response-property-enum-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 2fecf8a6aa0b24See the full diff
    • ▲

      added to the //// response property oneOf list for the response status

      response-property-one-of-added

    • ▲

      added to the ///// response property oneOf list for the response status

      response-property-one-of-added

    • ○

      added to the ////////// response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added to the /////////// response property anyOf list for the response status

      response-property-any-of-added

    • ○

      added ArticleCollectionBlock discriminator mapping keys to the //// response property for the response status

      response-property-discriminator-mapping-added

    • ○

      added ArticleCollectionBlock discriminator mapping keys to the ///// response property for the response status

      response-property-discriminator-mapping-added

  • b06feb9e16304See the full diff
    • ○

      removed AddStoreNode AddToSegmentNode AddUserAchievementNode BanUserNode BatchBanUserNode BrowserPopupNotificationActionNode BrowserPushNotificationActionNode CreateCouponNode CreateItemBannerActionNode CreateUserStoreSettingsNode CreateVirtualSKUNode DeclinePaymentNode EmailActionNode ItemAddNode ItemCategorySortNode MobilePopupActionNode MobilePushActionNode PWAPromptActionNode RemoveFromSegmentNode Require3DSNode RequirePennyDropNode SetAttributeValuesNode SortStoreItemsNode TimerNode VerifyPlayerNode WebhookActionNode discriminator mapping keys from the //////// response property for the response status

      response-property-discriminator-mapping-deleted

    • ○

      removed AddStoreNode AddToSegmentNode AddUserAchievementNode BanUserNode BatchBanUserNode BrowserPopupNotificationActionNode BrowserPushNotificationActionNode CreateCouponNode CreateItemBannerActionNode CreateUserStoreSettingsNode CreateVirtualSKUNode DeclinePaymentNode EmailActionNode ItemAddNode ItemCategorySortNode MobilePopupActionNode MobilePushActionNode PWAPromptActionNode RemoveFromSegmentNode Require3DSNode RequirePennyDropNode SetAttributeValuesNode SortStoreItemsNode TimerNode VerifyPlayerNode WebhookActionNode discriminator mapping keys from the ///////// response property for the response status

      response-property-discriminator-mapping-deleted

    • ○

      removed from the //////// response property oneOf list for the response status

      response-property-one-of-removed

    • ○

      removed from the ///////// response property oneOf list for the response status

      response-property-one-of-removed

    This revision also has 10 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 102d483c8b8124See the full diff
    • ▲

      added to the //////// response property oneOf list for the response status

      response-property-one-of-added

    • ▲

      added to the ///////// response property oneOf list for the response status

      response-property-one-of-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added RequirePennyDropNode discriminator mapping keys to the //////// response property for the response status

      response-property-discriminator-mapping-added

    • ○

      added RequirePennyDropNode discriminator mapping keys to the ///////// response property for the response status

      response-property-discriminator-mapping-added

  • 8662e77bc1e222See the full diff
    • ▲

      added to the //////// response property oneOf list for the response status

      response-property-one-of-added

    • ▲

      added to the ///////// response property oneOf list for the response status

      response-property-one-of-added

    • ○

      added BanUserNode BatchBanUserNode DeclinePaymentNode Require3DSNode discriminator mapping keys to the //////// response property for the response status

      response-property-discriminator-mapping-added

    • ○

      added BanUserNode BatchBanUserNode DeclinePaymentNode Require3DSNode discriminator mapping keys to the ///////// response property for the response status

      response-property-discriminator-mapping-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • a14f6ce6d1878See the full diff
    • ○

      added the optional property ////////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property ////////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /////////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property /////////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the required property / to the response with the status

      response-required-property-added

    • ○

      added the required property // to the response with the status

      response-required-property-added

    This revision also has 13 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog