Skip to main content
Hero Light

​
Overview

The SitePlot API provides programmatic access to your content management system, enabling you to integrate SitePlot’s powerful features into your applications and workflows. Our REST API follows industry standards and provides consistent, predictable URLs that accept JSON-encoded request bodies and return JSON-encoded responses.

​
Base URL

All API requests should be made to: 
https://your-domain.com/api/v1

​
API Version

The current API version is v1. All endpoints are prefixed with /api/v1/ to ensure backward compatibility as we evolve the API.

​
Rate Limiting

API requests are rate-limited to ensure optimal performance for all users. Current limits:
  • 1000 requests per hour per API key
  • 10 requests per second burst limit
Rate limit headers are included in all responses:
  • X-RateLimit-Limit: The maximum number of requests allowed per hour
  • X-RateLimit-Remaining: The number of requests remaining in the current window
  • X-RateLimit-Reset: The time when the rate limit window resets (Unix timestamp)

​
Response Format

All API responses follow a consistent structure:

​
Success Response

{
  "data": [...], // The requested data
  "meta": {
    "total": 150,
    "page": 1,
    "pageSize": 20,
    "totalPages": 8
  }
}

​
Error Response

{
  "error": "Error type",
  "message": "Human-readable error description"
}

​
Pagination

List endpoints support pagination using query parameters:
  • page: Page number (default: 1)
  • pageSize: Number of items per page (default: 20, max: 100)
Pagination metadata is included in the meta object of successful responses.

​
Getting Started

Authentication

Learn how to authenticate your API requests using API keys

Quickstart

Make your first API call in under 5 minutes

Forms API

Manage forms and retrieve form submissions

Page Builder API

Access pages and manage redirects

​
Support

Need help? Our support team is here to assist you:
  • Email: [email protected]
  • Documentation: Browse our comprehensive guides
  • Community: Join our developer community for discussions and tips

​
SDKs and Libraries

Official SDKs are available for popular programming languages:
  • JavaScript/Node.js: npm install @siteplot/api
  • Python: pip install siteplot-api
  • PHP: composer require siteplot/api
Community-maintained libraries are also available for other languages.
⌘I