{"templateId":"api_docs","sharedDataIds":{"apiDocsStore":"api-docs-docs/openapi.json","sidebar":"sidebar-developer/sidebars.yaml"},"props":{"definitionId":"docs/openapi.json","settings":{"baseUrlPath":"/docs/openapi"},"disableAutoScroll":true,"seo":{"title":"HRC Ledger API","description":"Read US healthcare contracts and organizations, and work with your saved work, from your own code.","siteUrl":"https://docs.hrcledger.com","llmstxt":{"title":"HRC Ledger API","description":"One key, one envelope, every route and guide."}},"dynamicMarkdocComponents":[],"metadata":{"type":"openapi","title":"HRC Ledger API","version":"v1","description":"The HRC Ledger API gives a healthcare investment banker's own code what HRC Ledger holds: healthcare organizations and public contracts, your saved Lists, action plans, drafts and conversations, and the HRC Ledger assistant.\n\n**Authenticate** with an API key in one header: `Authorization: Bearer hck_live_...`. A key works on any plan; each key carries the scopes it was made with.\n\n**One envelope** on every route: `{ ok: true, data, page?, total? }`, or `{ ok: false, error: { code, message, ...details } }`. Every response carries an `X-Request-Id` header; quote it when you ask us about a call.\n\n**Versioning is in the path** (`/api/v1`): a change that removes or retypes a field in `data` ships at a new path; adding a field does not.\n\n**Guides** — getting started, keys and scopes, errors, pagination and versioning, and the changelog — are at https://docs.hrcledger.com/developer/."},"compilationErrors":[],"markdown":{"partials":{},"variables":{"rbac":{"teams":["anonymous"]},"user":{},"remoteAddr":{"hostname":"docs.societyhealth.co","port":4000,"ipAddress":"216.73.216.25"},"lang":"default_locale","env":{"PUBLIC_REDOCLY_BRANCH_NAME":"main"}}},"pagePropGetterError":{"message":"","name":""}},"slug":"/docs/openapi","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}