SympleHost Developers
Build integrations against the SympleHost Partner API. Pull reservations, transactions, and unified-inbox messages; link properties; and automate partner workflows with scoped API keys.
Quickstart
- Read the Partner API HTML docs.
- Load the machine-readable contract: /openapi.json (also YAML).
- Authenticate with HTTP Basic for read-only non-sensitive scopes, or HMAC-SHA256 for sensitive scopes.
- Request
Accept: application/vnd.symplehost.partner.v1+json. - Paginate with opaque keyset cursors (
meta.next_cursor).
OpenAPI
/openapi.json— primary JSON contract/api/openapi.json— alternate path/partner-api/openapi.yaml— YAML source/.well-known/api-catalog— API catalog
CLI
The official SympleHost CLI (symplehost on npm)
queries the Partner API from the terminal — reservations, transactions, properties, and
conversations, with cursor pagination:
npm install -g symplehost
export SYMPLEHOST_KEY_ID=key_... SYMPLEHOST_SECRET=...
symplehost reservations Base URLs
- Production:
https://platform.symplehost.ai - Development:
https://platform-dev.symplehost.ai
Errors
API errors use a JSON envelope with stable machine code values. Example problem
detail: /api/v1/errors/example.
Contact
Partners: partners@symplehost.ai · Support: support@symplehost.ai