Overview
REST reference for the Basker Partners API: authentication, querying, and per-resource endpoints
The Basker Partners API is the authenticated REST API for external integrations. It syncs content with external systems, powers mobile apps, and connects 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 the API scopes requests 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 the placeholder with your own slug. - API versions are date-based (
2026-02,2025-07). See Versioning for details. - 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 REST contract. - Theme-facing read APIs. Public read-only JSON served from your own Basker site (
{your-domain}/api/...) appears under FrontStage API in 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 are not part of the Partners API. They are not supported for external use. - Webhooks. The app that provides a webhook documents its behavior.