Sign in

v52

latestOpenAPI 3.0.3raw.githubusercontent.com2026-07-2113138232.4 KB
pages

show details for all pages

Retrieve details for all Page objects in the system.

    ### Pages Overview:
    - Pages are custom static or dynamic views hosted on the Forem instance.
    - Publicly visible unless restricted.
    - Helpful for building custom menus, rendering site policies, or embedding custom forms.
get/api/pages

Response

successful

titlestring required

Title of the page

slugstring required

Used to link to this page in URLs, must be unique and URL-safe

descriptionstring required

For internal use, helps similar pages from one another

body_markdownstring nullable

The text (in markdown) of the ad (required)

body_jsonstring nullable

For JSON pages, the JSON body

is_top_level_pathboolean

If true, the page is available at '/{slug}' instead of '/page/{slug}', use with caution

social_imageobject nullable
template'contained' | 'full_within_layout' | 'nav_bar_included' | 'json' | 'css' | 'txt' required

Controls what kind of layout the page is rendered in