Overview
REST reference for the Basker Partners API: authentication, querying, and per-resource endpoints
The Basker Partners API is the authenticated REST API for syncing content with external systems, powering mobile apps, and connecting Basker to other services. It provides tenant-scoped access to pages, events, event instances, people, venues, editorial content, media, forms, redirects, and custom data.
Start here
- Authentication: API keys and request headers.
- Multi-tenancy: how requests are scoped to a tenant.
- Versioning: date-based path versions and how to migrate.
- Rate limits: limits per API key and how to back off cleanly.
- Querying: pagination, filtering, field selection, and the full query parameters reference.
- Response format and error envelope.
- Status codes: success, client-error, and server-error outcomes to handle.
- Schema discovery: inspect tenant-specific blocks, theme settings, and custom attributes before writing them.
- Configured-field updates: safely update custom attributes or theme settings across several records.
- Reference: per-resource endpoint documentation generated from the current OpenAPI contract.
Conventions used in this section
- All examples use the live host
https://api.basker.app. The path shape is/partners/{version}/{tenant}/.... - Tenant slugs in examples use a placeholder like
remarkable-theatre. Replace with your own. - API versions are date-based (
2026-02,2025-07); see Versioning. - cURL is the canonical example syntax. For other languages, see Client libraries.
Other API surfaces
- GraphQL. The Partners runtime also exposes GraphQL at
/partners/{version}/{tenant}/graphql; this section documents the supported REST contract. - Theme-facing read APIs. Public read-only JSON served from your own Basker site (
{your-domain}/api/...) is documented under FrontStage API inside the Themes section. Use it for browser-side widgets in a theme. - Admin and editor APIs. The
/api/...paths used by the Basker admin to author content aren't part of the Partners API and aren't supported for external use. - Webhooks. Webhook behavior belongs to the app that provides it and is documented with that app.