Skip to main content
GET
/
api
/
v1
/
page-builder
curl -X GET "https://your-domain.com/api/v1/page-builder?published=true&pageSize=10" \
  -H "Authorization: Bearer sk_live_1234567890abcdef" \
  -H "Content-Type: application/json"

{
  "data": [
    {
      "id": "page_1234567890abcdef",
      "title": "Home",
      "slug": "home",
      "path": "/",
      "pageType": "page",
      "isPublished": true,
      "publishedAt": "2024-01-10T09:00:00Z",
      "createdAt": "2024-01-05T14:30:00Z",
      "updatedAt": "2024-01-10T09:00:00Z"
    },
    {
      "id": "page_0987654321fedcba",
      "title": "About Us",
      "slug": "about",
      "path": "/about",
      "pageType": "page",
      "isPublished": true,
      "publishedAt": "2024-01-08T11:15:00Z",
      "createdAt": "2024-01-06T10:00:00Z",
      "updatedAt": "2024-01-12T16:45:00Z"
    },
    {
      "id": "page_abcdef1234567890",
      "title": "Contact",
      "slug": "contact",
      "path": "/contact",
      "pageType": "page",
      "isPublished": true,
      "publishedAt": "2024-01-09T13:20:00Z",
      "createdAt": "2024-01-07T12:00:00Z",
      "updatedAt": "2024-01-09T13:20:00Z"
    }
  ],
  "meta": {
    "total": 3,
    "page": 1,
    "pageSize": 20,
    "totalPages": 1
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.usesiteplot.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

This endpoint returns all pages in your SitePlot page builder with pagination support. You can filter results to show only published pages and control the number of results per page.

​
Authentication

​
Authorization
string
required
Bearer token with your API key: Bearer YOUR_API_KEY

​
Query Parameters

​
page
integer
default:"1"
Page number for pagination. Must be 1 or greater.
​
pageSize
integer
default:"20"
Number of items per page. Must be between 1 and 100.
​
published
boolean
If set to true, returns only published pages. If omitted, returns all pages regardless of publication status.

​
Response

​
data
array
Array of page objects
​
meta
object
Pagination metadata
curl -X GET "https://your-domain.com/api/v1/page-builder?published=true&pageSize=10" \
  -H "Authorization: Bearer sk_live_1234567890abcdef" \
  -H "Content-Type: application/json"

{
  "data": [
    {
      "id": "page_1234567890abcdef",
      "title": "Home",
      "slug": "home",
      "path": "/",
      "pageType": "page",
      "isPublished": true,
      "publishedAt": "2024-01-10T09:00:00Z",
      "createdAt": "2024-01-05T14:30:00Z",
      "updatedAt": "2024-01-10T09:00:00Z"
    },
    {
      "id": "page_0987654321fedcba",
      "title": "About Us",
      "slug": "about",
      "path": "/about",
      "pageType": "page",
      "isPublished": true,
      "publishedAt": "2024-01-08T11:15:00Z",
      "createdAt": "2024-01-06T10:00:00Z",
      "updatedAt": "2024-01-12T16:45:00Z"
    },
    {
      "id": "page_abcdef1234567890",
      "title": "Contact",
      "slug": "contact",
      "path": "/contact",
      "pageType": "page",
      "isPublished": true,
      "publishedAt": "2024-01-09T13:20:00Z",
      "createdAt": "2024-01-07T12:00:00Z",
      "updatedAt": "2024-01-09T13:20:00Z"
    }
  ],
  "meta": {
    "total": 3,
    "page": 1,
    "pageSize": 20,
    "totalPages": 1
  }
}

​
Error Responses

{
  "error": "invalid_api_key",
  "message": "The provided API key is invalid or has been revoked"
}

​
Page Types

The pageType field indicates the type of page:
TypeDescription
pageStandard content page
master_layoutTemplate page used as a layout for other pages
landing_pageSpecialized landing page for marketing campaigns

​
Use Cases

Build dynamic navigation menus by retrieving all published pages and their paths.

​
Content Management

Integrate with external content management systems or build custom admin interfaces.

​
SEO and Analytics

Generate sitemaps, track page performance, and analyze content structure.

​
Backup and Migration

Export page metadata for backup purposes or migration to other systems.

​
Filtering Examples

​
Get Only Published Pages

GET /api/v1/page-builder?published=true

​
Get All Pages (Including Drafts)

GET /api/v1/page-builder

​
Paginate Through Large Sites

GET /api/v1/page-builder?page=2&pageSize=50