OpenAPI Specification

PageGun provides a complete OpenAPI 3.1 specification for the v1 API.

Spec URL

https://api.pagegun.com/v1/openapi

Or as a static file:

https://pagegun.com/openapi.json

Usage

Import into Postman

Open Postman
Click Import
Paste URL: https://api.pagegun.com/v1/openapi
Click Import

Use with Swagger UI

<script src="https://unpkg.com/swagger-ui-dist/swagger-ui-bundle.js"></script>
<div id="swagger-ui"></div>
<script>
SwaggerUIBundle({
  url: "https://api.pagegun.com/v1/openapi",
  dom_id: '#swagger-ui',
})
</script>

Generate Client Libraries

# Using openapi-generator
npx @openapitools/openapi-generator-cli generate \
  -i https://api.pagegun.com/v1/openapi \
  -g typescript-fetch \
  -o ./pagegun-client

What's Included

The spec covers all v1 API endpoints:

Projects — List, Create, Get, Update
Pages — List, Create, Get, Update
Publishing — Publish, Unpublish
Settings — Get, Update
Data Mode — Status, Enable, Disable, Regenerate Key

All schemas include TypeScript-friendly type definitions with proper nullability annotations.