API Integration Guide

Learn how to interact with our RESTful API to create, manage, and retrieve guestbook entries programmatically.

Get Started

Need Help?

v3.1.0 - October 2025 Update

View on GitHub

🚀 Getting Started

To start using Open Guestbook's API, you need a valid site ID and API key from your dashboard. Once you have these credentials, you can interact with guestbook entries in your own codebase.

  • Find your site ID and API key in the dashboard
  • Choose between REST API or SDK integration
  • Read our full API reference for endpoint details

Quick Start Code


// Get guestbook entries
fetch('https://api.openguestbook.tech/v3/entries')
  .then(response => response.json())
  .then(data => console.log(data))

Add your API key to the Authorization header before use.

🔐 Authentication

Using API Tokens

Add your API key to the Authorization header with the Bearer scheme: 


Authorization: Bearer YOUR_API_TOKEN

Tokens are long-lived and should be securely stored. Regenerate if compromised.

Token Expiry

Access tokens never expire by default. You may revoke them at any time in your dashboard.

  • Never store tokens in client-side code
  • Use rotating keys for prod environments

✅ Available Endpoints

/api/v3/entries

GET

Get All Entries

Retrieve guestbook entries with optional sorting, filtering, and pagination.

Accept: application/json
Content-Type: application/json

/api/v3/entries

POST

Add Entry

Submit a new entry to the guestbook with name, message, and optional metadata.

Authentication: Required

{
  "name": "Jane Doe",
  "message": "Great site!",
  "email": "jane@example.com"
}

/api/v3/entries/{id}

DELETE

Remove Entry

Requires admin authentication and proof of data ownership.

Authorization: Bearer {token}

URL: https://api.openguestbook.tech/api/v3/entries/12345

💡 Code Examples

JavaScript


// Get entries
fetch('https://api.openguestbook.tech/v3/entries', {
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN'
  }
})
.then(res => res.json())
.then(data => console.log(data))

Python


import requests

response = requests.get(
    'https://api.openguestbook.tech/v3/entries', 
    headers={'Authorization': 'Bearer YOUR_TOKEN'}
)
print(response.json())

🎯 Best Practices

Use pagination

Add ?page=1&limit=20 to large requests

Validate inputs

Never trust raw user data from API responses

Handle errors

Check HTTP status codes in error responses

Ready to Build Something?

The Open Guestbook API works with any programming language or framework you choose. Check out our GitHub examples for Node.js, Python, and more.

View API Samples