Beyond Pricing Partners API¶
Welcome to the Beyond Pricing Partners API documentation. This API enables third-party services to integrate with Beyond Pricing's revenue management platform for short-term vacation rentals.
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
- Accounts -- connect channel accounts (PMS, Airbnb, etc.)
Key Features¶
- Authentication -- OAuth2 (client credentials for partners, device flow for personal clients), optional personal access tokens (
bpat_…), following RFC 9700 - JSON:API Format -- consistent, predictable 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
- OpenAPI Documentation -- auto-generated interactive API reference via Swagger UI
Quick Links¶
| Resource | Description |
|---|---|
| Authentication | Compare client credentials, device flow, and personal access tokens |
| Getting Started | Choose the onboarding path for your client type |
| Partner Onboarding Flow | Follow the end-to-end setup flow from user creation to listing activation |
| Server Integrations | Confidential client setup for server-to-server integrations |
| CLI And Headless Clients | Device authorization for single-user automation tools |
| API Endpoints | Full endpoint reference with examples |
| Swagger UI | Interactive API explorer |
| ReDoc | Clean API reference |
| 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