FOforem
pages

show details for all pages

Changed on

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

Request

  • Base URL
    https://dev.to
  • Auth
    none required

Query parameters

organization_idinteger

Filter pages belonging to a specific organization ID, ordered by position.

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
organization_idinteger nullable

The ID of the organization the page belongs to, if any

positioninteger

Display order position for organization pages

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

Controls what kind of layout the page is rendered in

Changes

  • v10c2dc5146f56Revision changes
    • info

      added the new optional query request parameter organization_id

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • v1c9e7662755c2Revision changes
    • warning

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

    • warning

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