Beyond Pricing Partners API¶
The Partners API enables programmatic integration with Beyond Pricing's revenue management platform for short-term vacation rentals. There are two ways to use it — pick the path that matches you.
Choose Your Path¶
| You are… | Start here |
|---|---|
A partner or company integrating many Beyond users on a secure backend — white-label products, multi-tenant platforms, server-to-server jobs. Uses OAuth2 client credentials, optional user_id / credential_id narrowing, and IP allowlists. |
For Partners |
| An individual Beyond user automating tasks on your own listings — scripts, cron jobs, CLIs, agents. Uses a personal access token (PAT). | For Personal Users |
Not sure which applies? If you authenticate with a client secret on a backend you control and manage other people's Beyond accounts, you are a partner. If you are automating your own Beyond account, you are a personal user. The Authentication overview compares every mechanism side by side.
What You Can Do¶
The Partners API v1 provides programmatic access to:
- Listings -- retrieve and manage property listings with pricing data
- Calendar -- access availability and pricing calendars
- Users -- create and manage user accounts (partner integrations)
- Accounts -- connect channel accounts (PMS, Airbnb, etc.)
Shared Reference¶
- Authentication -- OAuth2 client credentials for partners, personal access tokens (
bpat_…) for individual users, following RFC 9700 - JSON:API Format -- consistent request and response structure per the JSON:API specification (v1.1)
- Rate Limiting -- transparent limits with response headers for client-side throttling
- Error Handling -- standardized error responses with actionable details
- Versioning -- URL-based versioning with a clear deprecation policy
- API Reference -- interactive Swagger UI and ReDoc, auto-generated via OpenAPI
- Release Notes -- changelog of API updates and improvements
AI-Driven Client Implementation¶
When implementing API clients with AI tools, provide both schema-level and narrative docs context:
- OpenAPI Specification: schema endpoint for precise endpoint contracts, field types, and request/response structures
- Full Documentation (Markdown): single markdown document for authentication, guides, behavior details, and endpoint usage examples in one file
Base URL¶
All API requests use the base URL of your Beyond Pricing Partners deployment (e.g., https://partners.beyondpricing.com). Throughout this documentation, curl examples use $BASE_URL as a placeholder:
Support¶
For questions about your API integration:
- Email: api-support@beyondpricing.com