API Reference

Use this section for exact generated request and response schemas plus the small set of contracts that apply across operations.

API-wide Contracts

• Authentication summary
• Error contract
• Pagination and filtering
• Dry Run Mode
• Books Closed Override
• Issue Catalog
• Webhook Catalog
• Changelog

Generated Operations

Endpoint pages are generated from the public OpenAPI document and grouped by resource in the sidebar. They are the exact contract for paths, methods, fields, query parameters, schemas, and operation-specific dry-run support.

For client generation, browse the interactive reference at https://api.vrplatform.app/spec and fetch the OpenAPI document from https://api.vrplatform.app/openapi.json.

Common entry points:

• Accounts
• Connections
• Contacts
• Listings
• Reservations
• Statements
• Transactions
• Webhooks

For business decisions and complete workflows, start at Build your own UI, Integrate data, or Operate.