API Reference - Pages

Link: https://support.brilliantdirectories.com/support/solutions/articles/12000108123

← Back to API Reference | Getting Started

Pages

The Pages table stores all SEO-enabled pages on a directory site, including the homepage, static content pages, category pages, and custom landing pages. Each record controls the page's URL slug, title tags, meta data, on-page content, and display options. This is primarily a reference and content table; typical API usage is GET operations to retrieve page data, with updates made via the admin panel.

Model name in URL: list_seo — DB table: list_seo

The Page Object

Field	Type	Description
`seo_id`	integer	Unique page ID (primary key, read-only)
`master_id`	integer	Master record ID; `0` for site-level records
`seo_type`	string	Page type identifier (EG `home`, `profile`, `search`); max 255 characters
`database`	string	Database table associated with this page type; max 255 characters
`section`	string	Section or sub-type for this page; max 255 characters
`database_id`	integer	ID of the associated database record (EG category ID, service ID); `0` for global pages
`filename`	string	URL slug for this page (EG `home`, `about-us`); max 1000 characters
`title`	text	HTML title tag content; supports platform template tokens (EG `%Profession%`)
`meta_keywords`	text	Meta keywords for this page; supports platform template tokens
`meta_desc`	text	Meta description for this page; supports platform template tokens
`seo_text`	text	Additional SEO body text displayed on the page
`date_updated`	string	Timestamp of last update in `YYYYMMDDHHmmss` format; max 14 characters
`updated_by`	string	Email or identifier of the admin who last updated this record; max 255 characters
`facebook_title`	string	Open Graph title for social sharing; max 255 characters
`facebook_desc`	text	Open Graph description for social sharing
`facebook_image`	string	Open Graph image URL for social sharing; max 255 characters
`h1`	text	H1 heading text for this page; supports template tokens
`h2`	text	H2 heading text for this page; supports template tokens
`breadcrumb`	string	Breadcrumb label for this page; max 255 characters
`content_menu`	string	Menu section this page belongs to; max 255 characters
`nickname`	string	Human-readable label for this page used in the admin panel (EG `Homepage`); max 255 characters
`content_order`	integer	Sort order for this page within its menu/section
`content`	text	Main HTML content body of the page; supports widgets via `[widget=Name]` shortcodes
`content_footer`	text	Additional HTML content displayed below the main content area
`content_active`	integer	Whether the content section is active and displayed; `1` = active, `0` = hidden
`show_form`	integer	Whether to display a contact form on this page; `1` = show, `0` = hide
`form_name`	string	Name of the form to display if `show_form` is enabled; max 255 characters
`content_images`	text	JSON array of image references used in the page content
`content_css`	text	Custom CSS scoped to this page (nullable)
`content_settings`	text	JSON object of additional page settings and layout options
`menu_layout`	string	Layout template to use for the navigation menu on this page; max 255 characters
`hide_from_menu`	integer	Whether to hide this page from navigation menus; `1` = hidden, `0` = visible
`hide_header_links`	integer	Whether to hide header navigation links on this page; `1` = hidden, `0` = visible
`hide_header`	integer	Whether to hide the site header on this page; `1` = hidden, `0` = visible
`hide_footer`	integer	Whether to hide the site footer on this page; `1` = hidden, `0` = visible
`hide_top_right`	integer	Whether to hide the top-right header area on this page; `1` = hidden, `0` = visible
`org_template`	integer	ID of the page template/layout to use for this page
`content_group`	string	Group label for organizing this page in the admin panel; max 255 characters
`content_layout`	string	Layout variant to use for the content area of this page; max 255 characters
`content_head`	text	HTML or widget shortcodes injected into the page header area (nullable)
`content_sidebar`	string	Sidebar configuration or widget shortcode for this page; max 255 characters
`revision_timestamp`	timestamp	Last modified timestamp (auto-updated)
`custom_html_placement`	string	Custom HTML placement identifier for this page; max 255 characters
`allowed_products`	string	Comma-separated list of plan/product IDs that can access this page; empty means all plans; max 255 characters
`content_footer_html`	text	Raw HTML injected at the bottom of this page, below content and footer areas (nullable)
`enable_hero_section`	string	Enable hero section on this page (0 or 1)
`hero_image`	string	Hero section background image URL
`hero_section_content`	string	Hero section HTML content
`hero_alignment`	string	Hero content alignment (left, center, right)
`hero_column_width`	string	Hero content column width
`hero_top_padding`	string	Hero section top padding in pixels
`hero_bottom_padding`	string	Hero section bottom padding in pixels
`hero_content_font_size`	string	Hero content body font size
`hero_content_font_color`	string	Hero content body font color
`hero_content_overlay_color`	string	Hero background overlay color
`hero_content_overlay_opacity`	string	Hero background overlay opacity
`hero_background_image_size`	string	Hero background image CSS size (cover, contain, etc.)
`hero_hide_banner_ad`	string	Hide banner ad when hero is active (0 or 1)
`hero_link_text`	string	Hero call-to-action link text
`hero_link_url`	string	Hero call-to-action link URL
`hero_link_color`	string	Hero call-to-action link color
`hero_link_size`	string	Hero call-to-action link font size
`hero_link_target_blank`	string	Open hero link in new tab (0 or 1)
`h1_font_size`	string	Hero H1 heading font size
`h1_font_weight`	string	Hero H1 heading font weight
`h1_font_color`	string	Hero H1 heading font color
`h2_font_size`	string	Hero H2 heading font size
`h2_font_weight`	string	Hero H2 heading font weight
`h2_font_color`	string	Hero H2 heading font color
`linked_post_type`	string	Linked post type for this page
`linked_post_category`	string	Linked post category for this page
`private_page_select`	string	Private page access control setting
`page_render_widget`	string	Widget ID to render as page content

List Pages

GET /api/v2/list_seo/get

Returns a paginated list of page records.

Example Request

Copy

curl -X GET "https://www.yourdomain.com/api/v2/list_seo/get?limit=25" \
  -H "X-Api-Key: your-api-key-here"

Example Response

Copy

{
  "status": "success",
  "message": [
    {
      "seo_id": "1",
      "master_id": "0",
      "seo_type": "home",
      "database": "",
      "section": "",
      "database_id": "0",
      "filename": "home",
      "title": "%Profession% Directory - Find %%Profession%% - %%%website_name%%%",
      "meta_keywords": "%%%industry%%%,%%%profession%%%, %%%website_name%%%",
      "meta_desc": "Search the most complete %profession% directory.",
      "seo_text": "",
      "date_updated": "20260127152045",
      "updated_by": "admin@example.com",
      "facebook_title": "%%%Profession%%% Directory",
      "facebook_desc": "Find %%%profession%%% near you.",
      "facebook_image": "",
      "h1": "",
      "h2": "",
      "breadcrumb": "",
      "content_menu": "",
      "nickname": "Homepage",
      "content_order": "0",
      "content": "",
      "content_footer": "",
      "content_active": "1",
      "show_form": "0",
      "form_name": "",
      "content_images": "",
      "content_css": "",
      "content_settings": "",
      "menu_layout": "",
      "hide_from_menu": "0",
      "hide_header_links": "0",
      "hide_header": "0",
      "hide_footer": "0",
      "hide_top_right": "0",
      "org_template": "89",
      "content_group": "initial_content",
      "content_layout": "",
      "content_head": "",
      "content_sidebar": "",
      "revision_timestamp": "2026-03-28 11:35:02",
      "custom_html_placement": "",
      "allowed_products": "",
      "content_footer_html": ""
    }
  ],
  "total": "42",
  "current_page": 1,
  "total_pages": 2,
  "next_page": "MipfKjI="
}

Retrieve a Page Record

GET /api/v2/list_seo/get/{seo_id}

Example Request

Copy

curl -X GET "https://www.yourdomain.com/api/v2/list_seo/get/1" \
  -H "X-Api-Key: your-api-key-here"

Example Response

Copy

{
  "status": "success",
  "message": [
    {
      "seo_id": "1",
      "master_id": "0",
      "seo_type": "home",
      "filename": "home",
      "nickname": "Homepage",
      "title": "%Profession% Directory - Find %%Profession%% - %%%website_name%%%",
      "revision_timestamp": "2026-03-28 11:35:02"
    }
  ],
  "total": "1",
  "current_page": 1,
  "total_pages": 1
}

Create a Page Record

POST /api/v2/list_seo/create

Example Request

Copy

curl -X POST "https://www.yourdomain.com/api/v2/list_seo/create" \
  -H "X-Api-Key: your-api-key-here" \
  -d "seo_type=custom" \
  -d "filename=about-us" \
  -d "nickname=About+Us" \
  -d "title=About+Us+-+%%%website_name%%%" \
  -d "meta_desc=Learn+more+about+our+directory." \
  -d "content_active=1"

Example Response

Copy

{
  "status": "success",
  "message": {
    "seo_id": "43",
    "master_id": null,
    "seo_type": "custom",
    "filename": "about-us",
    "nickname": "About Us",
    "title": "About Us - %%%website_name%%%",
    "content_active": "1"
  }
}

Update a Page Record

PUT /api/v2/list_seo/update

Example Request

Copy

curl -X PUT "https://www.yourdomain.com/api/v2/list_seo/update" \
  -H "X-Api-Key: your-api-key-here" \
  -d "seo_id=43" \
  -d "title=About+Our+Directory+-+%%%website_name%%%" \
  -d "meta_desc=Discover+who+we+are+and+what+we+offer."

Example Response

Copy

{
  "status": "success",
  "message": {
    "seo_id": "43",
    "seo_type": "custom",
    "filename": "about-us",
    "nickname": "About Us",
    "title": "About Our Directory - %%%website_name%%%",
    "meta_desc": "Discover who we are and what we offer."
  }
}

Delete a Page Record

DELETE /api/v2/list_seo/delete

Example Request

Copy

curl -X DELETE "https://www.yourdomain.com/api/v2/list_seo/delete" \
  -H "X-Api-Key: your-api-key-here" \
  -d "seo_id=43"

Example Response

Copy

{
  "status": "success",
  "message": "list_seo record was deleted"
}

What Do You Need Help With?

API Reference - Pages

Pages

The Page Object

List Pages

Example Request

Example Response

Retrieve a Page Record

Example Request

Example Response

Create a Page Record

Example Request

Example Response

Update a Page Record

Example Request

Example Response

Delete a Page Record

Example Request

Example Response

Related Articles