Skip to content
Shepherd Developers

API reference is live

← Back to blog

·Shepherd Engineering ·1 min read

  • api
  • announcement

The API reference section of the portal is live. It covers:

  • Foundations: authentication, conventions (the POST-everywhere transport, pagination, embedding, sorting, date filters), errors, and rate limits.
  • Resources: clients, patients, appointments, SOAP records, invoices, prescriptions, inventory, products, providers, and lookups.
  • Code samples in curl, Python, C#, PHP, and JavaScript on every endpoint example, with synced language tabs across the page.

Where the schemas live

Authoritative request and response schemas continue to live in the live Swagger UI. This site complements the Swagger with concepts, end-to-end tutorials, and the same examples in five languages, rather than re-publishing every schema field on a second surface that could drift.

What’s next

  • More end-to-end tutorials covering common integration patterns (booking sync, lab result ingestion, payment reconciliation).
  • Release notes alongside backend rollouts so partners can track changes from one place.