API overview - Harmstack

The Harmstack REST API is a JSON REST API. All endpoints live under the /v0 path prefix and use bearer token authentication.

Base URL

https://api.harmstack.com/v0

The exact base URL is provided when you receive your API key. Use the URL supplied by your account team rather than assuming the one above.

All public endpoints are versioned under /v0. The version is part of the URL path — there are no version headers or query parameters.

Admin-only endpoints are intentionally excluded from this documentation. Contact Vetted Medical support if you believe you need admin access.

Every endpoint returns JSON. Successful responses include the relevant resource or list of resources directly in the response body.

When a request fails, the API returns an HTTP error status code and a JSON body describing the problem.

Status	Meaning
`400 Bad Request`	The request was malformed or missing required fields. Check your request body and parameters.
`401 Unauthorized`	The `Authorization` header is missing, malformed, or contains an invalid or revoked API key.
`404 Not Found`	The requested resource does not exist or is not accessible to your account.
`500 Internal Server Error`	An unexpected error occurred on the server. Retry the request, and contact support if the problem persists.

Error responses follow this shape:

{
  "error": "description of the problem"
}