API Endpoints

This section documents all available Beyond API v1 endpoints. For full request/response schemas with the ability to make live calls, use the interactive API reference tools:

Tool	URL	Description
Swagger UI	/api/v1/docs/	Interactive API explorer -- browse endpoints, try requests, view schemas
ReDoc	/api/v1/redoc/	Clean, readable API reference
OpenAPI Schema	/api/v1/schema/	Downloadable OpenAPI 3.0 spec (YAML) for code generation

To download the schema for use with code generators:

curl -o openapi.yaml $BASE_URL/api/v1/schema/

Endpoint Summary

Endpoint	Method	Scope	Token Tier	Description
/api/v1/listings/	GET	listings:read	Both	List all listings
/api/v1/listings/<id>/	GET	listings:read	Both	Get listing details
/api/v1/listings/<id>/activation/	PATCH	listings:write	Both	Enable or disable price syncing for a listing
/api/v1/listings/<id>/refresh/	POST	listings:write	Both	Queue a reservations refresh for a listing
/api/v1/listings/<id>/calendar/	GET	reservations:read	Both	Get listing calendar
/api/v1/compsets/	GET	compsets:read	Both	List the comp sets you can see (paginated summary)
/api/v1/compsets/<id>/	GET	compsets:read	Both	Get one comp set, fully enriched
/api/v1/listings/<id>/market-insights/	GET	insights:read	Both	Compare a listing's daily performance with its neighborhood benchmark
/api/v1/listings/<id>/recommendations/	GET	listings:read	Both	List recommendations for a listing
/api/v1/listings/<id>/customizations/	GET	listings:read	Both	Get all customizations for a listing in one response
/api/v1/listings/<id>/customizations/base-price/	GET	listings:read	Both	Get base price customization for a listing
/api/v1/listings/<id>/customizations/base-price/	PATCH	listings:write	Both	Update base price customization for a listing
/api/v1/listings/<id>/customizations/min-stays/	GET	listings:read	Both	Get min-stays customization for a listing
/api/v1/listings/<id>/customizations/min-stays/	PATCH	listings:write	Both	Update min-stays customization for a listing
/api/v1/listings/<id>/customizations/extra-guest-fees/	GET	listings:read	Both	Get extra guest fee customization for a listing
/api/v1/listings/<id>/customizations/extra-guest-fees/	PATCH	listings:write	Both	Update extra guest fee customization for a listing
/api/v1/listings/<id>/customizations/min-max-prices/	GET	listings:read	Both	Get min/max prices customization for a listing
/api/v1/listings/<id>/customizations/min-max-prices/	PATCH	listings:write	Both	Update min/max prices customization for a listing
/api/v1/listings/<id>/customizations/time-based-adjustments/	GET	listings:read	Both	Get time-based adjustments customization for a listing
/api/v1/listings/<id>/customizations/time-based-adjustments/	PATCH	listings:write	Both	Update time-based adjustments customization for a listing
/api/v1/listings/<id>/customizations/manual-overrides/	GET	listings:read	Both	Get manual price overrides for a listing
/api/v1/listings/<id>/customizations/manual-overrides/	PATCH	listings:write	Both	Update manual price overrides for a listing
/api/v1/users/	GET	user:read	Both	List users
/api/v1/users/	POST	user:write	App-level only	Create a user
/api/v1/users/<id>/	GET	user:read	Both	Retrieve a user
/api/v1/users/<id>/credentials/	GET	user:read	Both	List credentials for a user
/api/v1/users/<id>/	DELETE	user:write	App-level only	Delete a user
/api/v1/users/<id>/accounts/	GET	user:read	Both	List accounts for a user
/api/v1/users/<id>/accounts/	POST	user:write	Both	Add an account for a user
/api/v1/users/<id>/accounts/<id>/	GET	user:read	Both	Get one account for a user
/api/v1/users/<id>/accounts/<id>/refresh/	POST	user:write	Both	Queue a full refresh for an account
/api/v1/users/<id>/accounts/<id>/	DELETE	user:write	Both	Delete an account
/api/v1/webhook-configuration/	GET	webhooks:read	Both	Read your webhook destination and event selection
/api/v1/webhook-configuration/	PATCH	webhooks:write	App-level only	Change your webhook destination or event selection
/api/v1/webhook-events/	GET	webhooks:read	Both	List the webhook events delivered to you
/api/v1/webhook-events/<msg_id>/	GET	webhooks:read	Both	Retrieve one delivered event, including its body

Token Tier key:

• App-level only: Requires an application-level token (no user_id).
• Both: Works with either an app-level token (all resources) or a user-scoped token (bound user's resources only).

See User-Scoped Tokens for details.

Common Patterns

All endpoints follow the same conventions:

• Authentication: OAuth2 Bearer token in the Authorization header
• Content-Type: application/vnd.api+json
• Response format: JSON:API
• Pagination: Page-based with page[number] and page[size] (defaults and maximums vary by endpoint)
• Errors: Structured JSON:API error responses