Skip to main content
The Trailflow Partner API contract is available through the API reference tab in this portal and is surfaced from the canonical OpenAPI 3.1 specification. This page exists to clarify how the contract should be consumed. The OpenAPI document is the source of truth for endpoint definitions, but it is most useful when read alongside the integration guides, examples, authentication rules, versioning notes, and webhook behavior documented in this portal. Use the API reference for:
  • endpoint paths and methods
  • request and response schemas
  • parameter definitions
  • status codes and error envelopes
Use the guides in this portal for:
  • authentication and idempotency rules
  • polling and pagination behavior
  • webhook signing and retries
  • representative example payloads
  1. Start with the API reference when you need exact schemas and field names.
  2. Use the guides when you need to understand workflow behavior, retries, pagination, signing, and implementation expectations.
  3. Use the examples page to compare representative request and response bodies before automating an integration or handing the work to an agent.
For contract change tracking, also review the changelog.