Skip to main content

API reference

The SiPhox Health API is organized around REST. It has predictable, resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

note

The full, always-current endpoint reference with a live playground is the interactive Swagger at connect.siphoxhealth.com/api-docs: authorize it with your sandbox token to try calls live. The endpoint guides in this tab cover the concepts, flags, and gotchas the raw reference does not.

Base URL​

Both environments run on the same base URL; the token you send decides whether a request is live or sandboxed. See Authentication for the full environment model.

https://connect.siphoxhealth.com

Resources​

The core resources map onto the kit lifecycle:

  • Orders: purchases of kits and credits.
  • Kits: physical test kits and their lifecycle status.
  • Customers: the people you test.
  • Reports: processed biomarker results, released to customers.

Authenticate every request with your API token in the Authorization header. See Authentication for details.