← Back to product·Simulmedia Switchboard Docs · v1 draft·API reference / Overview
API reference

Overview

Base URL: https://api.switchboard.simulmedia.com/v1 (sandbox: api.sandbox.switchboard.simulmedia.com/v1). JSON everywhere; UTF-8; UTC on all timestamps. Auth per Authentication. TLS required. See Conventions for idempotency, pagination, and error shape; every request and response shape is defined once in the objects reference.

Every card below links to that endpoint's full reference: parameters, field tables, examples, and errors.

Seller endpoints

Publish what you sell, then decide what books. Your capability profile declares which of these you serve.

Connection

Catalog, rates, avails

Orders

Buyer endpoints

Discover, book, track, reconcile.

Discovery

Orders

Events and webhooks

Agreements and settlement

HTTP status codes

StatusMeaning
200 / 201Success; 201 on resource creation
202Accepted for async processing (confirm, decide, cancel)
204Success, no body (webhook dedup acknowledgement)
400Malformed request syntax
401Missing or invalid token
403Valid token, insufficient scope or agreement
404Resource not found within your scope
409Conflict: same external_order_id with a different payload, or action not valid in current state (identical duplicates replay the original response instead)
422Semantically invalid: non-allowlisted notify_url, unknown package_id, etc.
429Rate limit; Retry-After header present
5xxPlatform fault; retry with backoff; the audit log will say exactly where