--- title: "Get Pages" method: GET path: "/v1/pages" tags: ["Pages"] --- # Get Pages `GET /v1/pages` ## Query parameters - `parent_id` string - `ignore_parent_id` boolean - `search_string` string - `limit` integer — A limit on the number of objects to be returned - `offset` integer — The number of objects to skip - `types` string — Optional comma separated list of types ## Response `200` Successful Response - PageRead[] - `key` string — External unique page identifier - `title` string, required — The title of the page - `text` string, required - `description` string, required — The description of the page - `slug` string, required — The slug of the page - `layout` PageLayout - `blocks` array[] - union[] - union - FullNewsBlock - `block` 'FullNewsBlock' - `id` string - `name` string - `start_at` integer - `end_at` integer - `news_id` string - FeaturedNewsBlock - `block` 'FeaturedNewsBlock' - `id` string - `name` string - `start_at` integer - `end_at` integer - `news_id` string - `hide_date` boolean - TwitchBlock - `block` 'TwitchBlock' - `id` string - `name` string - `start_at` integer - `end_at` integer - `video` VideoBlockSettings, required - … - YoutubeBlock - `block` 'YoutubeBlock' - `id` string - `name` string - `start_at` integer - `end_at` integer - `video` VideoBlockSettings, required - … - TextBlock - `block` 'TextBlock' - `id` string - `name` string - `start_at` integer - `end_at` integer - `text` string - `title` string - BannerBlock - `block` 'BannerBlock' - `id` string - `name` string - `start_at` integer - `end_at` integer - `description` string - `image_url` string - `title` string - `background_image_size` string - FeaturedItemBlock - `block` 'FeaturedItemBlock' - `id` string - `name` string - `start_at` integer - `end_at` integer - `item_id` string - `store_item_id` string - `store_id` string - `fallback_store_item_id` string - `fallback_store_id` string - `fallback_item_id` string - `background_image_size` string - `category_template_id` string - RedeemCouponBlock - `block` 'RedeemCouponBlock' - `id` string - `name` string - `start_at` integer - `end_at` integer - `variant` 'default' | 'block' — An enumeration. - `title` string - `description` string - `button_text` string - `background_image_url` string - LatestNewsBlock - `block` 'LatestNewsBlock' - `id` string - `name` string - `start_at` integer - `end_at` integer - `variant` 'standard' | 'carousel' — An enumeration. - `hide_controls` boolean - `is_featured` boolean - LatestPagesBlock - `block` 'LatestPagesBlock' - `id` string - `name` string - `start_at` integer - `end_at` integer - `variant` 'linear' | 'blur' — An enumeration. - `collection_id` string - `category_id` string - `is_featured` boolean - `is_paginated` boolean - `show_all_tab` boolean - LeaderboardCardBlock - `block` 'LeaderboardCardBlock' - `id` string - `name` string - `start_at` integer - `end_at` integer - `leaderboard_id` string - LeaderboardFullBlock - `block` 'LeaderboardFullBlock' - `id` string - `name` string - `start_at` integer - `end_at` integer - `leaderboard_id` string - LeaderboardCollectionBlock - `block` 'LeaderboardCollectionBlock' - `id` string - `name` string - `start_at` integer - `end_at` integer - StoreBlock - `block` 'StoreBlock' - `id` string - `name` string - `start_at` integer - `end_at` integer - `store_id` string - `category_id` string - `featured_category_id` string - `show_sticky_categories` boolean - LimitedStoreBannerBlock - `block` 'LimitedStoreBannerBlock' - `id` string - `name` string - `start_at` integer - `end_at` integer - `title` string - `description` string - `button` string - `image_url` string - `background_image_url` string - `link` string - `store_id` string - AchievementListBlock - `block` 'AchievementListBlock' - `id` string - `name` string - `start_at` integer - `end_at` integer - FeaturedPageBlock - `block` 'FeaturedPageBlock' - `id` string - `name` string - `start_at` integer - `end_at` integer - `page_id` string, required - `is_collection` boolean - `rotation_period` integer - `hide_date` boolean - DailyRewardsBlock - `block` 'DailyRewardsBlock' - `id` string - `name` string - `start_at` integer - `end_at` integer - `variant` 'expanded' | 'compact' | 'compact_mobile' — An enumeration. - `non_compliance` boolean - LoyaltyProgramBlock - `block` 'LoyaltyProgramBlock' - `id` string - `name` string - `start_at` integer - `end_at` integer - `variant` 'standard' | 'expanded' | 'compact' — An enumeration. - `slider_on_mobile` boolean, nullable - IFrameBlock - `block` 'IFrameBlock' - `id` string - `name` string - `start_at` integer - `end_at` integer - `width` string - `height` string - `url` string, uri, required - `requires_auth` boolean - `popup_background_image` string, uri - `loading_background_image` string, uri - `crossplay_disabled` boolean - `is_web_game_iframe` boolean - `aspect_ratio` number - ImageBannerBlock - `block` 'ImageBannerBlock' - `id` string - `name` string - `start_at` integer - `end_at` integer - `link` string - `image_url` string, required - `button_text` string - `title` string - `text` string - RichContentBlock - `block` 'RichContentBlock' - `id` string - `name` string - `start_at` integer - `end_at` integer - `html` string, required - CarouselBlock - `block` 'CarouselBlock' - `id` string - `name` string - `start_at` integer - `end_at` integer - `type` 'offers', required — An enumeration. - `delay` integer - `loop` boolean - `autoplay` boolean - `show_dots` boolean - `category_template_id` string - SequentialOfferBlock - `block` 'SequentialOfferBlock' - `id` string - `name` string - `start_at` integer - `end_at` integer - `sequential_offer_id` string, required - RangeOfferBlock - `block` 'RangeOfferBlock' - `id` string - `name` string - `start_at` integer - `end_at` integer - `range_offer_id` string, required - ProgressionProgramBlock - `block` 'ProgressionProgramBlock' - `id` string - `name` string - `start_at` integer - `end_at` integer - `program_id` string, required - `variant` 'standard' | 'expanded' | 'compact' — An enumeration. - `slider_on_mobile` boolean, nullable - RollingOfferBlock - `block` 'RollingOfferBlock' - `id` string - `name` string - `start_at` integer - `end_at` integer - `rolling_offer_id` string, required - `max_items_count` integer - `scroll_disabled` boolean - `variant` 'slider' | 'snake' — An enumeration. - CarouselNewsBlock - `block` 'CarouselNewsBlock' - `id` string - `name` string - `start_at` integer - `end_at` integer - `delay` integer - `loop` boolean - `autoplay` boolean - `show_dots` boolean - PiggyBankOfferBlock - `block` 'PiggyBankOfferBlock' - `id` string - `name` string - `start_at` integer - `end_at` integer - `piggy_bank_offer_id` string, required - PlaceBlock - `block` 'PlaceBlock' - `id` string - `name` string - `start_at` integer - `end_at` integer - `key` string, required - PickOneOfferBlock - `block` 'PickOneOfferBlock' - `id` string - `name` string - `start_at` integer - `end_at` integer - `pick_one_offer_id` string, required - UserProfileBlock - `block` 'UserProfileBlock' - `id` string - `name` string - `start_at` integer - `end_at` integer - DynamicBlock - `block` 'DynamicBlock' - `id` string - `name` string - `start_at` integer - `end_at` integer - `graph_rules` GraphRoot, required - … - `html` string — The HTML content of the page - `type` 'content' | 'article' | 'news' | 'collection' | 'blocks' — An enumeration. - `parent_id` string, nullable — The ID of the parent page - `date` string, date, nullable - `datetime` integer, nullable — The date of the page - `image_url` union — The date of the page - string, uri - '' - `featured_image_url` string, uri, nullable — The URL of the featured image for the page - `pinned_image_url` string, uri, nullable — The URL of the pinned image for the page - `pinned_webview_image_url` string, uri, nullable — The URL of the pinned image for the page (in webview) - `published_at` integer, nullable — The published date of the Page - `position` integer, nullable — The position of the page in the page list - `render_options` PageRenderOptions - `is_promo_store` boolean - `child_sort_settings` PageSortSettings - `sort_by` 'position' | 'datetime', required — An enumeration. - `sort_order` 'asc' | 'desc', required — An enumeration. - `video_url` string, uri, nullable — The URL of the video for the page - `is_featured` boolean, nullable — Whether the page is featured - `is_pinned` boolean, nullable — Whether the page is pinned - `tags` string[], nullable — Tags for the page - `custom_url` string, uri, nullable — Custom URL that the page card links to instead of the page itself - `button_text` string, nullable — Text for the page card button - `requirements_expression` Expression - `tokens` Token[] - `type` 'attribute' | 'custom_attribute' | 'event_attribute' | 'custom_event_attribute' | 'operator' | 'number' | 'date' | 'string' | 'boolean' | 'list' | 'variable' | 'virtual_currency', required - `value` unknown - `variables` MathExpression[] - `tokens` Token[] - `type` 'attribute' | 'custom_attribute' | 'event_attribute' | 'custom_event_attribute' | 'operator' | 'number' | 'date' | 'string' | 'boolean' | 'list' | 'variable' | 'virtual_currency', required - `value` unknown - `name` string, required - `id` string, required - `parent` PageBase - `key` string — External unique page identifier - `title` string, required — The title of the page - `text` string, required - `description` string, required — The description of the page - `slug` string, required — The slug of the page - `layout` PageLayout - `blocks` array[] - union[] - union - FullNewsBlock - … - FeaturedNewsBlock - … - TwitchBlock - … - YoutubeBlock - … - TextBlock - … - BannerBlock - … - FeaturedItemBlock - … - RedeemCouponBlock - … - LatestNewsBlock - … - LatestPagesBlock - … - LeaderboardCardBlock - … - LeaderboardFullBlock - … - LeaderboardCollectionBlock - … - StoreBlock - … - LimitedStoreBannerBlock - … - AchievementListBlock - … - FeaturedPageBlock - … - DailyRewardsBlock - … - LoyaltyProgramBlock - … - IFrameBlock - … - ImageBannerBlock - … - RichContentBlock - … - CarouselBlock - … - SequentialOfferBlock - … - RangeOfferBlock - … - ProgressionProgramBlock - … - RollingOfferBlock - … - CarouselNewsBlock - … - PiggyBankOfferBlock - … - PlaceBlock - … - PickOneOfferBlock - … - UserProfileBlock - … - DynamicBlock - … - `html` string — The HTML content of the page - `type` 'content' | 'article' | 'news' | 'collection' | 'blocks' — An enumeration. - `parent_id` string, nullable — The ID of the parent page - `date` string, date, nullable - `datetime` integer, nullable — The date of the page - `image_url` union — The date of the page - string, uri - '' - `featured_image_url` string, uri, nullable — The URL of the featured image for the page - `pinned_image_url` string, uri, nullable — The URL of the pinned image for the page - `pinned_webview_image_url` string, uri, nullable — The URL of the pinned image for the page (in webview) - `published_at` integer, nullable — The published date of the Page - `position` integer, nullable — The position of the page in the page list - `render_options` PageRenderOptions - `is_promo_store` boolean - `child_sort_settings` PageSortSettings - `sort_by` 'position' | 'datetime', required — An enumeration. - `sort_order` 'asc' | 'desc', required — An enumeration. - `video_url` string, uri, nullable — The URL of the video for the page - `is_featured` boolean, nullable — Whether the page is featured - `is_pinned` boolean, nullable — Whether the page is pinned - `tags` string[], nullable — Tags for the page - `custom_url` string, uri, nullable — Custom URL that the page card links to instead of the page itself - `button_text` string, nullable — Text for the page card button - `requirements_expression` Expression - `tokens` Token[] - `type` 'attribute' | 'custom_attribute' | 'event_attribute' | 'custom_event_attribute' | 'operator' | 'number' | 'date' | 'string' | 'boolean' | 'list' | 'variable' | 'virtual_currency', required - `value` unknown - `variables` MathExpression[] - `tokens` Token[] - `type` 'attribute' | 'custom_attribute' | 'event_attribute' | 'custom_event_attribute' | 'operator' | 'number' | 'date' | 'string' | 'boolean' | 'list' | 'variable' | 'virtual_currency', required - `value` unknown - `name` string, required - `seo` PageSeo - `title` string - `description` string - `image_url` string, uri ## Other responses - `422` — Validation Error --- [API](https://skmtc.net/aghanim/apis/aghanim-server-to-server-api.md) · [All operations](https://skmtc.net/aghanim/apis/aghanim-server-to-server-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aghanim/aghanim-server-to-server-api/versions/6402c25762c8/schema)