Developer docs
Pinned Events API Developer Docs
Complete documentation for API authentication, scoped API keys, publishing events into channels, handling retries safely, debugging errors, using OpenAPI, and building production-ready integrations with the Pinned Events API.
Getting started
Create an API key, find a channelId, publish your first event, and retry safely.
Authentication
Authenticate Public API requests with bearer API keys from trusted server-side code.
API keys and scopes
Understand API key lifecycle, default quickstart scopes, owner-scoped channel access, and revocation behavior.
Channels
Every event is published into a channel. Use GET /api/public/v1/channels to find accessible channelId values.
Create events
Create draft or published events with required fields first, then add location, media, ticketing, and publishing options.
Idempotency
Use stable Idempotency-Key headers so webhook retries and import jobs do not create duplicate event listings.
Errors
Understand the error envelope, common status codes, and how to debug failed Public API requests.
Rate limits
Understand 429 responses, Retry-After handling, and retry strategies for busy integrations.
Pagination
Understand pagination fields returned by list endpoints, including page, limit, totalDocs, totalPages, hasNextPage, and hasPrevPage.
Versioning and OpenAPI
Use the OpenAPI schema, versioned /api/public/v1 routes, and documented deprecation policy for production integrations.
Security
Store keys server-side, use least privilege, rotate and revoke keys, and keep secrets out of logs.
Troubleshooting
Diagnose authentication failures, forbidden channel access, validation errors, duplicate events, and rate limits.
Examples
Copy production-oriented integration patterns for CMS, CRM, forms, spreadsheets, nightly imports, Node.js, and Python.
FAQ
Quick answers to common developer and product questions about the Pinned Events API.
Interactive API referenceSchemas and examples.OpenAPI YAMLMachine-readable schema.ChangelogPublic API updates.
AI and LLM documentation
Machine-readable Developer API context for AI coding tools, agents, and documentation retrieval.