Pages

Get Pages

Changed on
get/v1/pages

Request

  • Base URL
    https://api.aghanim.com/s2s
  • URL
    https://api.aghanim.com/s2s/v1/pages
  • Auth
    HTTP bearer

Query parameters

parent_idstring
ignore_parent_idboolean
search_stringstring
limitinteger

A limit on the number of objects to be returned

offsetinteger

The number of objects to skip

typesstring

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

  • 8eb4b912783bRevision changes
    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

  • b37d69d55261Revision changes
    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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