Sign in
Pages

Get Page

get/v1/pages/{page_id}

Path parameters

page_idstring required

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 pin reaches.

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 4 of the 15 revisions of this API.418

  • 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 layout/blocks/items/items/oneOf[subschema #33: DynamicBlock]/graph_rules/nodes/additionalProperties/ response property for the response status 200

      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 parent/layout/blocks/items/items/oneOf[subschema #33: DynamicBlock]/graph_rules/nodes/additionalProperties/ response property for the response status 200

      response-property-discriminator-mapping-deleted

    • ○

      removed EmailActionNode MobilePushActionNode MobilePopupActionNode TimerNode BrowserPushNotificationActionNode BrowserPopupNotificationActionNode PWAPromptActionNode WebhookActionNode CreateItemBannerActionNode CreateVirtualSKUNode CreateUserStoreSettingsNode SetAttributeValuesNode VerifyPlayerNode AddUserAchievementNode CreateCouponNode ItemAddNode AddToSegmentNode RemoveFromSegmentNode AddStoreNode SortStoreItemsNode ItemCategorySortNode BanUserNode BatchBanUserNode Require3DSNode DeclinePaymentNode RequirePennyDropNode from the layout/blocks/items/items/oneOf[subschema #33: DynamicBlock]/graph_rules/nodes/additionalProperties/ response property oneOf list for the response status 200

      response-property-one-of-removed

    • ○

      removed EmailActionNode MobilePushActionNode MobilePopupActionNode TimerNode BrowserPushNotificationActionNode BrowserPopupNotificationActionNode PWAPromptActionNode WebhookActionNode CreateItemBannerActionNode CreateVirtualSKUNode CreateUserStoreSettingsNode SetAttributeValuesNode VerifyPlayerNode AddUserAchievementNode CreateCouponNode ItemAddNode AddToSegmentNode RemoveFromSegmentNode AddStoreNode SortStoreItemsNode ItemCategorySortNode BanUserNode BatchBanUserNode Require3DSNode DeclinePaymentNode RequirePennyDropNode from the parent/layout/blocks/items/items/oneOf[subschema #33: DynamicBlock]/graph_rules/nodes/additionalProperties/ response property oneOf list for the response status 200

      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 RequirePennyDropNode to the layout/blocks/items/items/oneOf[subschema #33: DynamicBlock]/graph_rules/nodes/additionalProperties/ response property oneOf list for the response status 200

      response-property-one-of-added

    • ▲

      added RequirePennyDropNode to the parent/layout/blocks/items/items/oneOf[subschema #33: DynamicBlock]/graph_rules/nodes/additionalProperties/ response property oneOf list for the response status 200

      response-property-one-of-added

    • ○

      added the optional property parent/pin_scope to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property pin_scope to the response with the 200 status

      response-optional-property-added

    • ○

      added RequirePennyDropNode discriminator mapping keys to the layout/blocks/items/items/oneOf[subschema #33: DynamicBlock]/graph_rules/nodes/additionalProperties/ response property for the response status 200

      response-property-discriminator-mapping-added

    • ○

      added RequirePennyDropNode discriminator mapping keys to the parent/layout/blocks/items/items/oneOf[subschema #33: DynamicBlock]/graph_rules/nodes/additionalProperties/ response property for the response status 200

      response-property-discriminator-mapping-added

  • 8662e77bc1e222See the full diff
    • ▲

      added BanUserNode BatchBanUserNode Require3DSNode DeclinePaymentNode to the layout/blocks/items/items/oneOf[subschema #33: DynamicBlock]/graph_rules/nodes/additionalProperties/ response property oneOf list for the response status 200

      response-property-one-of-added

    • ▲

      added BanUserNode BatchBanUserNode Require3DSNode DeclinePaymentNode to the parent/layout/blocks/items/items/oneOf[subschema #33: DynamicBlock]/graph_rules/nodes/additionalProperties/ response property oneOf list for the response status 200

      response-property-one-of-added

    • ○

      added BanUserNode BatchBanUserNode DeclinePaymentNode Require3DSNode discriminator mapping keys to the layout/blocks/items/items/oneOf[subschema #33: DynamicBlock]/graph_rules/nodes/additionalProperties/ response property for the response status 200

      response-property-discriminator-mapping-added

    • ○

      added BanUserNode BatchBanUserNode DeclinePaymentNode Require3DSNode discriminator mapping keys to the parent/layout/blocks/items/items/oneOf[subschema #33: DynamicBlock]/graph_rules/nodes/additionalProperties/ response property for the response status 200

      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 layout/blocks/items/items/oneOf[subschema #33: DynamicBlock]/graph_rules/nodes/additionalProperties/oneOf[subschema #8: PWAPromptActionNode]/position to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property layout/blocks/items/items/oneOf[subschema #33: DynamicBlock]/graph_rules/nodes/additionalProperties/oneOf[subschema #8: PWAPromptActionNode]/skip_dialog to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property parent/layout/blocks/items/items/oneOf[subschema #33: DynamicBlock]/graph_rules/nodes/additionalProperties/oneOf[subschema #8: PWAPromptActionNode]/position to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property parent/layout/blocks/items/items/oneOf[subschema #33: DynamicBlock]/graph_rules/nodes/additionalProperties/oneOf[subschema #8: PWAPromptActionNode]/skip_dialog to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property parent/webhook_id to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property webhook_id to the response with the 200 status

      response-optional-property-added

    • ○

      added the required property layout_source to the response with the 200 status

      response-required-property-added

    • ○

      added the required property parent/layout_source to the response with the 200 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