{
"success": false,
"message": "Internal server error"
}
Provider Filtering: Only providers with active=true AND hide_in_availability=false will appear in availability results. If you’ve set a provider’s hide_in_availability to true, they won’t appear here even if their status is active.
Use provider_ids and location_ids to narrow returned availability. Both parameters accept comma-separated EHR IDs, for example provider_ids=prov1,prov2 and location_ids=loc1,loc2. Location filtering is applied to generated availability windows using each slot’s facility_id; slots without a facility_id are excluded when location_ids is provided.
{ "success": true, "results": { "availability": [ { "day_of_week": 5, "date": "2024-04-05", "duration_string": "9h", "range_start": "2024-04-05T08:00:00.000-07:00", "range_end": "2024-04-05T17:00:00.000-07:00", "provider_id": "3498234", "facility_id": "1", // if available in the EHR "facility_name": "Main St Clinic", // if available in the EHR "visit_type": "New Patient" // only present when calculation_method=slots } ] }, "timezone": "America/Los_Angeles"}
When using calculation_method=slots, if the EHR provides detailed slot information, the response may include additional fields for capacity management:
Key fields when detailed slot information is available:
visit_type: The specific appointment type that can be booked in this slot
available_appointments: How many more appointments can still be scheduled in this slot
max_visits: The total capacity of this slot (useful for understanding how many are already booked)
facility_id: Unique identifier for the facility/location
facility_name: Name of the facility/location
The availability of these enhanced fields depends on your EHR system’s capabilities. Not all EHRs provide this level of detail for slot-based availability.
Scenario 1: A “New Patient” schedule_slot exists at 10:00 AM. A “Follow-up” appointment is already booked at 10:00 AM.
gaps: 10:00 AM not returned as available (appointment occupies that time)
slots: “New Patient” slot returned as available (different appointment type doesn’t block)
equal_slots: “New Patient” slot not returned (any appointment blocks all slot types)
Scenario 2: A “New Patient” schedule_slot exists at 10:00 AM. A “New Patient” appointment is already booked at 10:00 AM.
gaps: 10:00 AM not returned as available (appointment occupies that time)
slots: “New Patient” slot not returned (same appointment type blocks)
equal_slots: “New Patient” slot not returned (any appointment blocks all slot types)
Scenario 3: A “New Patient” schedule_slot exists at 10:00 AM. A schedule_block (e.g., “Lunch”) exists at 10:00 AM.
gaps: 10:00 AM not returned as available (schedule_block occupies that time)
slots: “New Patient” slot not returned (schedule_blocks block slots)
equal_slots: “New Patient” slot not returned (schedule_blocks block all slot types)
Use equal_slots when multiple parties (e.g., clinic staff and automated systems) are scheduling different appointment types into the same time slots and you need to prevent double-booking.
Comma-separated appointment statuses to treat as cancelled, freeing the slot. When provided, this overrides the default cancelled/rescheduled detection. The default detection treats "c", "cancelled", "canc", "rescheduled", "r/s" and "deleted" as cancelled (PTPracticePro uses "3" in place of "c"); for eClinicalWorks it also treats any status containing "canc", "r/s" or "resched" as cancelled. Statuses are matched case-insensitively. To keep the default detection and add your own statuses, use additional_cancelled_statuses instead.
Comma-separated appointment statuses to treat as cancelled in addition to the default cancelled/rescheduled detection (or to cancelled_statuses, when provided); statuses are matched case-insensitively. Use this to add custom status codes without losing the defaults.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Cobalt","colors":{"primary":"#576dee","light":"#8a9af4","dark":"#3a4cbc"},"logo":{"light":"https://mintcdn.com/cobalt-cd7844c1/ARV8r_xeyMO_zivG/logo/light.svg?fit=max\u0026auto=format\u0026n=ARV8r_xeyMO_zivG\u0026q=85\u0026s=de8566184dd7d19c926d1f0e5ee04d74","dark":"https://mintcdn.com/cobalt-cd7844c1/ARV8r_xeyMO_zivG/logo/dark.svg?fit=max\u0026auto=format\u0026n=ARV8r_xeyMO_zivG\u0026q=85\u0026s=c9b017690a9cf87eea9b8c1a41a0330e"},"favicon":"https://mintcdn.com/cobalt-cd7844c1/NyZchDiv0WDjeFlo/favicon.svg?fit=max\u0026auto=format\u0026n=NyZchDiv0WDjeFlo\u0026q=85\u0026s=f4adc378c31a71ebba62a9d5d28f3bb6","navbar":{"links":[{"href":"mailto:bryan@usecobalt.com","label":"Support"}]},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/usecobalt"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"cobalt-cd7844c1","hasAudioNarration":false,"actualSubdomain":"cobalt-cd7844c1","customDomains":["docs.usecobalt.com"],"gitSource":{"type":"github","owner":"cobalt-technology","repo":"docs","deployBranch":"master","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6af36163d69d1eff064370e2","clientVersion":"0.0.4102","searchFilterCounts":[{"language":"default","tag":"API Reference","count":89},{"language":"default","tag":"Guides","count":31},{"language":"default","tag":"Webhooks","count":13},{"language":"default","tag":"Account","count":8},{"language":"default","tag":"Orders","count":6},{"language":"default","tag":"Patients","count":6},{"language":"default","tag":"Appointments","count":5},{"language":"default","tag":"Link","count":5},{"language":"default","tag":"Claims","count":4},{"language":"default","tag":"Documents","count":4}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/availability/get","slug":"/api-reference/availability/get","pageMetadata":{"title":"Get Availability","openapi":"GET /availability","description":"Returns open scheduling slots computed from synced provider hours and booked appointments over a date range.","href":"/api-reference/availability/get"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Returns open scheduling slots computed from synced provider hours and booked appointments over a date range.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Note}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);return _jsxs(_Fragment,{children:[_jsx(Note,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Provider Filtering`}),`: Only providers with `,_jsx(_components.code,{children:`active=true`}),` AND `,_jsx(_components.code,{children:`hide_in_availability=false`}),` will appear in availability results. If you’ve set a provider’s `,_jsx(_components.code,{children:`hide_in_availability`}),` to `,_jsx(_components.code,{children:`true`}),`, they won’t appear here even if their status is active.`]})}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`Use `,_jsx(_components.code,{children:`provider_ids`}),` and `,_jsx(_components.code,{children:`location_ids`}),` to narrow returned availability. Both parameters accept comma-separated EHR IDs, for example `,_jsx(_components.code,{children:`provider_ids=prov1,prov2`}),` and `,_jsx(_components.code,{children:`location_ids=loc1,loc2`}),`. Location filtering is applied to generated availability windows using each slot’s `,_jsx(_components.code,{children:`facility_id`}),`; slots without a `,_jsx(_components.code,{children:`facility_id`}),` are excluded when `,_jsx(_components.code,{children:`location_ids`}),` is provided.`]})}),`\n`,_jsx(Heading,{level:`3`,id:`example-request`,children:`Example Request`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`12`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`12`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` GET`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://api.usecobalt.com/v1/availability`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`-H `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'Content-Type: application/json'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`-H `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'client_id: ci_live_198908HJDKJSH98789OHKJL'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`-H `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'client_secret: cs_live_9827hofdsklOYYHJLJh'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`-H `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`'access_token: 493JKLHIU98789hLKH9HHJH'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`-G `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:`\\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`--data-urlencode `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"start_date=2024-03-14T00:00:00-07:00\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`--data-urlencode `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"end_date=2024-04-14T23:59:59-07:00\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`--data-urlencode `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"calculation_method=slots\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`--data-urlencode `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"provider_ids=3498234,9834521\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`--data-urlencode `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"location_ids=1\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`--data-urlencode `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"cancelled_statuses=canc,rs,cancsms\"`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`example-response`,children:`Example Response`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`19`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`19`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"success\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"results\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: {`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"availability\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"day_of_week\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`5`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"date\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2024-04-05\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"duration_string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"9h\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"range_start\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2024-04-05T08:00:00.000-07:00\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"range_end\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2024-04-05T17:00:00.000-07:00\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"provider_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"3498234\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"facility_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"1\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// if available in the EHR`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"facility_name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Main St Clinic\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:`// if available in the EHR`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"visit_type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"New Patient\"`}),_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` // only present when calculation_method=slots`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"timezone\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"America/Los_Angeles\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`enhanced-response-with-detailed-slot-information`,children:`Enhanced Response with Detailed Slot Information`}),`\n`,_jsxs(_components.p,{children:[`When using `,_jsx(_components.code,{children:`calculation_method=slots`}),`, if the EHR provides detailed slot information, the response may include additional fields for capacity management:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`32`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`32`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"success\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`true`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"availability\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"day_of_week\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`2`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"date\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2025-01-14\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"duration_string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"30 minutes\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"range_start\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2025-01-14T09:00:00.000-08:00\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"range_end\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2025-01-14T09:30:00.000-08:00\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"provider_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"12345\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"visit_type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"New Patient Visit\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"available_appointments\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`3`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"max_visits\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`5`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"facility_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"LOC-001\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"facility_name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Main Office\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"day_of_week\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`2`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"date\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2025-01-14\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"duration_string\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"15 minutes\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"range_start\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2025-01-14T10:00:00.000-08:00\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"range_end\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"2025-01-14T10:15:00.000-08:00\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"provider_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"12345\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"visit_type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Follow-up\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"available_appointments\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"max_visits\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`1`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"facility_id\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"LOC-001\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"facility_name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Main Office\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ],`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"timezone\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"America/Los_Angeles\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Key fields when detailed slot information is available:`})}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`visit_type`}),`: The specific appointment type that can be booked in this slot`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`available_appointments`}),`: How many more appointments can still be scheduled in this slot`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`max_visits`}),`: The total capacity of this slot (useful for understanding how many are already booked)`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`facility_id`}),`: Unique identifier for the facility/location`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`facility_name`}),`: Name of the facility/location`]}),`\n`]}),`\n`,_jsx(Note,{children:_jsx(_components.p,{children:`The availability of these enhanced fields depends on your EHR system’s capabilities. Not all EHRs provide this level of detail for slot-based availability.`})}),`\n`,_jsx(Heading,{level:`2`,id:`calculation-methods`,children:`Calculation Methods`}),`\n`,_jsxs(_components.p,{children:[`The `,_jsx(_components.code,{children:`calculation_method`}),` parameter determines how availability is calculated:`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`gaps`}),` (Default): Calculates availability based on free time between a provider’s working hours and existing appointments`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`slots`}),`: Pre-defined appointment slots blocked only by appointments matching the slot’s visit type`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`equal_slots`}),`: Pre-defined appointment slots blocked by ANY appointment at that time, regardless of type`]}),`\n`]}),`\n`,_jsx(Heading,{level:`3`,id:`example-scenarios`,children:`Example Scenarios`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Scenario 1:`}),` A “New Patient” schedule_slot exists at 10:00 AM. A “Follow-up” appointment is already booked at 10:00 AM.`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`gaps`}),`: 10:00 AM `,_jsx(_components.strong,{children:`not returned as available`}),` (appointment occupies that time)`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`slots`}),`: “New Patient” slot `,_jsx(_components.strong,{children:`returned as available`}),` (different appointment type doesn’t block)`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`equal_slots`}),`: “New Patient” slot `,_jsx(_components.strong,{children:`not returned`}),` (any appointment blocks all slot types)`]}),`\n`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Scenario 2:`}),` A “New Patient” schedule_slot exists at 10:00 AM. A “New Patient” appointment is already booked at 10:00 AM.`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`gaps`}),`: 10:00 AM `,_jsx(_components.strong,{children:`not returned as available`}),` (appointment occupies that time)`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`slots`}),`: “New Patient” slot `,_jsx(_components.strong,{children:`not returned`}),` (same appointment type blocks)`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`equal_slots`}),`: “New Patient” slot `,_jsx(_components.strong,{children:`not returned`}),` (any appointment blocks all slot types)`]}),`\n`]}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Scenario 3:`}),` A “New Patient” schedule_slot exists at 10:00 AM. A schedule_block (e.g., “Lunch”) exists at 10:00 AM.`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`gaps`}),`: 10:00 AM `,_jsx(_components.strong,{children:`not returned as available`}),` (schedule_block occupies that time)`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`slots`}),`: “New Patient” slot `,_jsx(_components.strong,{children:`not returned`}),` (schedule_blocks block slots)`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`equal_slots`}),`: “New Patient” slot `,_jsx(_components.strong,{children:`not returned`}),` (schedule_blocks block all slot types)`]}),`\n`]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`Use `,_jsx(_components.code,{children:`equal_slots`}),` when multiple parties (e.g., clinic staff and automated systems) are scheduling different appointment types into the same time slots and you need to prevent double-booking.`]})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get Availability","openapi":"GET /availability","description":"Returns open scheduling slots computed from synced provider hours and booked appointments over a date range.","href":"/api-reference/availability/get"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Example Request","slug":"example-request","depth":3,"children":[]},{"title":"Example Response","slug":"example-response","depth":3,"children":[]},{"title":"Enhanced Response with Detailed Slot Information","slug":"enhanced-response-with-detailed-slot-information","depth":3,"children":[]},{"title":"Calculation Methods","slug":"calculation-methods","depth":2,"children":[{"title":"Example Scenarios","slug":"example-scenarios","depth":3,"children":[]}]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"getAvailability","summary":"Get computed availability","description":"Returns open scheduling slots computed from synced provider hours and booked appointments over a date range.","tags":["Availability"],"x-supported-emrs":["Athena","Credible","DrChrono","eClinicalWorks","Experity","EZDERM","Modmed","ModmedEMA","ModmedGastro","OncoEMR","PracticeFusion","PTPracticePro","Raintree","WebPt"],"parameters":["ab39a3a0-fc06-4991-8da2-3aa4dd74730e","23578063-2f9a-4b18-9a09-8a95aa434c33","ebd475b8-c197-4239-8199-09034c757e32","2baadbe0-ccce-42c9-b56d-bf02daf632a1","b29c670d-f807-4f12-af44-cc09a2c5abd7","83aa5c06-5cca-4866-af8d-34e9046f053d","b5cfb77e-7f84-41c6-b6f7-a8637c587bb6","19426386-bcfe-4e29-94d2-087d7bb60384","96794b68-1133-422f-a3ed-1df9740bcfb0","001e379f-88fd-44c1-950e-f117e41ef452","08243548-36ff-4735-b90f-c64c428823d2","1ab7faa5-f2b7-46af-826a-f845d42e12a1","3da816ab-e032-46b6-a959-6c56e365fe5c","74623b3f-8d18-44b2-84ee-b408f99aa7c2","190e21ce-2d9f-44ff-848b-456812a8965b"],"responses":{"200":"3d5312bb-ea9b-4b28-86c4-dce79597ba23","400":"412006bf-8c14-45a8-873d-b2b8dbddd248","401":"f679d7e4-e545-4a89-b3a4-33036f110fd7","500":"1e56b1a7-1631-498f-8d34-ad74a5c77890"},"method":"get","type":"path","servers":["94b8e97d-9613-451e-8654-52265e15f71b"],"security":["c773c563-0c62-4e7f-8e45-5fe0fe8a95c3"],"path":"/availability","baseUrlOptions":["https://api.usecobalt.com/v1"],"title":"Get computed availability","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"ab39a3a0-fc06-4991-8da2-3aa4dd74730e":{"name":"start_date","in":"query","description":"Range start (ISO 8601 / YYYY-MM-DD).","schema":{"type":"string","example":"2026-03-15","isRequired":true,"description":"Range start (ISO 8601 / YYYY-MM-DD).","uniqueKey":"","typeLabel":"string"},"required":true,"x-supported-emrs":["Athena","Credible","DrChrono","eClinicalWorks","Experity","EZDERM","Modmed","ModmedEMA","ModmedGastro","OncoEMR","PracticeFusion","PTPracticePro","Raintree","WebPt"]},"23578063-2f9a-4b18-9a09-8a95aa434c33":{"name":"end_date","in":"query","description":"Range end (ISO 8601 / YYYY-MM-DD). Must be on/after start_date and within 12 months.","schema":{"type":"string","example":"2026-03-20","isRequired":true,"description":"Range end (ISO 8601 / YYYY-MM-DD). Must be on/after start_date and within 12 months.","uniqueKey":"","typeLabel":"string"},"required":true,"x-supported-emrs":["Athena","Credible","DrChrono","eClinicalWorks","Experity","EZDERM","Modmed","ModmedEMA","ModmedGastro","OncoEMR","PracticeFusion","PTPracticePro","Raintree","WebPt"]},"ebd475b8-c197-4239-8199-09034c757e32":{"name":"provider_ids","in":"query","description":"Comma-separated EMR provider IDs to filter by.","schema":{"type":"string","example":"PROV-1,PROV-2","isRequired":false,"description":"Comma-separated EMR provider IDs to filter by.","uniqueKey":"","typeLabel":"string"},"required":false,"x-supported-emrs":["Athena","Credible","DrChrono","eClinicalWorks","Experity","EZDERM","Modmed","ModmedEMA","ModmedGastro","OncoEMR","PracticeFusion","PTPracticePro","Raintree","WebPt"]},"2baadbe0-ccce-42c9-b56d-bf02daf632a1":{"name":"location_ids","in":"query","description":"Comma-separated EMR location IDs to filter slots by.","schema":{"type":"string","example":"LOC-1,LOC-2","isRequired":false,"description":"Comma-separated EMR location IDs to filter slots by.","uniqueKey":"","typeLabel":"string"},"required":false,"x-supported-emrs":["Athena","Credible","DrChrono","eClinicalWorks","Experity","EZDERM","Modmed","ModmedEMA","ModmedGastro","OncoEMR","PracticeFusion","PTPracticePro","Raintree","WebPt"]},"b29c670d-f807-4f12-af44-cc09a2c5abd7":{"name":"buffer","in":"query","description":"Minutes of buffer between slots (0–59).","schema":{"oneOf":[{"type":"integer","minimum":0,"example":15,"description":"Minutes of buffer between slots (0–59).","uniqueKey":"oneOf.0","typeLabel":"integer"},{"type":"null","minimum":0,"example":15,"description":"Minutes of buffer between slots (0–59).","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"integer | null"},"required":false,"x-supported-emrs":["Athena","Credible","DrChrono","eClinicalWorks","Experity","EZDERM","Modmed","ModmedEMA","ModmedGastro","OncoEMR","PracticeFusion","PTPracticePro","Raintree","WebPt"]},"83aa5c06-5cca-4866-af8d-34e9046f053d":{"name":"visit_type","in":"query","description":"Visit-type code to size slots for. Requires buffer.","schema":{"type":"string","example":"FOLLOW-UP","isRequired":false,"description":"Visit-type code to size slots for. Requires buffer.","uniqueKey":"","typeLabel":"string"},"required":false,"x-supported-emrs":["Athena","Credible","DrChrono","eClinicalWorks","Experity","EZDERM","Modmed","ModmedEMA","ModmedGastro","OncoEMR","PracticeFusion","PTPracticePro","Raintree","WebPt"]},"b5cfb77e-7f84-41c6-b6f7-a8637c587bb6":{"name":"calculation_method","in":"query","description":"Slot calculation method.","schema":{"type":"string","enum":["gaps","slots","equal_slots"],"default":"gaps","example":"gaps","isRequired":false,"description":"Slot calculation method.","uniqueKey":"","typeLabel":"enum\u003cstring>"},"required":false,"x-supported-emrs":["Athena","Credible","DrChrono","eClinicalWorks","Experity","EZDERM","Modmed","ModmedEMA","ModmedGastro","OncoEMR","PracticeFusion","PTPracticePro","Raintree","WebPt"]},"19426386-bcfe-4e29-94d2-087d7bb60384":{"name":"daily_appointment_limit","in":"query","description":"Max appointments per day. Requires daily_limit_type.","schema":{"oneOf":[{"type":"integer","minimum":1,"example":8,"description":"Max appointments per day. Requires daily_limit_type.","uniqueKey":"oneOf.0","typeLabel":"integer"},{"type":"null","minimum":1,"example":8,"description":"Max appointments per day. Requires daily_limit_type.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"integer | null"},"required":false,"x-supported-emrs":["Athena","Credible","DrChrono","eClinicalWorks","Experity","EZDERM","Modmed","ModmedEMA","ModmedGastro","OncoEMR","PracticeFusion","PTPracticePro","Raintree","WebPt"]},"96794b68-1133-422f-a3ed-1df9740bcfb0":{"name":"daily_limit_type","in":"query","description":"Visit-type code the daily limit applies to. Requires daily_appointment_limit.","schema":{"type":"string","example":"all","isRequired":false,"description":"Visit-type code the daily limit applies to. Requires daily_appointment_limit.","uniqueKey":"","typeLabel":"string"},"required":false,"x-supported-emrs":["Athena","Credible","DrChrono","eClinicalWorks","Experity","EZDERM","Modmed","ModmedEMA","ModmedGastro","OncoEMR","PracticeFusion","PTPracticePro","Raintree","WebPt"]},"001e379f-88fd-44c1-950e-f117e41ef452":{"name":"provider_type","in":"query","description":"Which provider slot to match on.","schema":{"type":"string","enum":["primary","secondary"],"example":"primary","isRequired":false,"description":"Which provider slot to match on.","uniqueKey":"","typeLabel":"enum\u003cstring>"},"required":false,"x-supported-emrs":["Athena","Credible","DrChrono","eClinicalWorks","Experity","EZDERM","Modmed","ModmedEMA","ModmedGastro","OncoEMR","PracticeFusion","PTPracticePro","Raintree","WebPt"]},"08243548-36ff-4735-b90f-c64c428823d2":{"name":"fallback_to_default_hours","in":"query","description":"Use default business hours when a provider has no configured hours.","schema":{"type":"string","enum":["true","false"],"example":"false","isRequired":false,"description":"Use default business hours when a provider has no configured hours.","uniqueKey":"","typeLabel":"enum\u003cstring>"},"required":false,"x-supported-emrs":["Athena","Credible","DrChrono","eClinicalWorks","Experity","EZDERM","Modmed","ModmedEMA","ModmedGastro","OncoEMR","PracticeFusion","PTPracticePro","Raintree","WebPt"]},"1ab7faa5-f2b7-46af-826a-f845d42e12a1":{"name":"max_slot_duration","in":"query","description":"Cap on slot length in minutes (5–60, multiples of 5).","schema":{"oneOf":[{"type":"integer","example":30,"description":"Cap on slot length in minutes (5–60, multiples of 5).","uniqueKey":"oneOf.0","typeLabel":"integer"},{"type":"null","example":30,"description":"Cap on slot length in minutes (5–60, multiples of 5).","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"integer | null"},"required":false,"x-supported-emrs":["Athena","Credible","DrChrono","eClinicalWorks","Experity","EZDERM","Modmed","ModmedEMA","ModmedGastro","OncoEMR","PracticeFusion","PTPracticePro","Raintree","WebPt"]},"3da816ab-e032-46b6-a959-6c56e365fe5c":{"name":"facility_scoped_scheduling","in":"query","description":"Scope slots per facility rather than per provider (auto-enabled for Practice Fusion).","schema":{"type":"string","enum":["true","false"],"example":"true","isRequired":false,"description":"Scope slots per facility rather than per provider (auto-enabled for Practice Fusion).","uniqueKey":"","typeLabel":"enum\u003cstring>"},"required":false,"x-supported-emrs":["Athena","Credible","DrChrono","eClinicalWorks","Experity","EZDERM","Modmed","ModmedEMA","ModmedGastro","OncoEMR","PracticeFusion","PTPracticePro","Raintree","WebPt"]},"74623b3f-8d18-44b2-84ee-b408f99aa7c2":{"name":"cancelled_statuses","in":"query","description":"Comma-separated appointment statuses to treat as cancelled, freeing the slot. When provided, this overrides the default cancelled/rescheduled detection. The default detection treats \"c\", \"cancelled\", \"canc\", \"rescheduled\", \"r/s\" and \"deleted\" as cancelled (PTPracticePro uses \"3\" in place of \"c\"); for eClinicalWorks it also treats any status containing \"canc\", \"r/s\" or \"resched\" as cancelled. Statuses are matched case-insensitively. To keep the default detection and add your own statuses, use additional_cancelled_statuses instead.","schema":{"type":"string","example":"canc,rs,cancsms","isRequired":false,"description":"Comma-separated appointment statuses to treat as cancelled, freeing the slot. When provided, this overrides the default cancelled/rescheduled detection. The default detection treats \"c\", \"cancelled\", \"canc\", \"rescheduled\", \"r/s\" and \"deleted\" as cancelled (PTPracticePro uses \"3\" in place of \"c\"); for eClinicalWorks it also treats any status containing \"canc\", \"r/s\" or \"resched\" as cancelled. Statuses are matched case-insensitively. To keep the default detection and add your own statuses, use additional_cancelled_statuses instead.","uniqueKey":"","typeLabel":"string"},"required":false,"x-supported-emrs":["Athena","Credible","DrChrono","eClinicalWorks","Experity","EZDERM","Modmed","ModmedEMA","ModmedGastro","OncoEMR","PracticeFusion","PTPracticePro","Raintree","WebPt"]},"190e21ce-2d9f-44ff-848b-456812a8965b":{"name":"additional_cancelled_statuses","in":"query","description":"Comma-separated appointment statuses to treat as cancelled in addition to the default cancelled/rescheduled detection (or to cancelled_statuses, when provided); statuses are matched case-insensitively. Use this to add custom status codes without losing the defaults.","schema":{"type":"string","example":"no show,bumped","isRequired":false,"description":"Comma-separated appointment statuses to treat as cancelled in addition to the default cancelled/rescheduled detection (or to cancelled_statuses, when provided); statuses are matched case-insensitively. Use this to add custom status codes without losing the defaults.","uniqueKey":"","typeLabel":"string"},"required":false,"x-supported-emrs":["Athena","Credible","DrChrono","eClinicalWorks","Experity","EZDERM","Modmed","ModmedEMA","ModmedGastro","OncoEMR","PracticeFusion","PTPracticePro","Raintree","WebPt"]}},"responses":{"3d5312bb-ea9b-4b28-86c4-dce79597ba23":{"description":"Computed availability for the requested range","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"availability":{"type":"array","items":{"type":"object","properties":{"day_of_week":{"type":"integer","description":"Day of week the slot falls on (Luxon weekday, 1=Mon..7=Sun).","example":5,"isRequired":true,"uniqueKey":"availability.items.[INDEX].day_of_week","typeLabel":"integer"},"date":{"type":"string","description":"Slot date (ISO 8601 date).","example":"2024-04-05","isRequired":true,"uniqueKey":"availability.items.[INDEX].date","typeLabel":"string"},"duration_string":{"type":"string","description":"Human-readable slot duration.","example":"540m","isRequired":true,"uniqueKey":"availability.items.[INDEX].duration_string","typeLabel":"string"},"range_start":{"type":"string","description":"Slot start (ISO 8601).","example":"2024-04-05T08:00:00.000-07:00","isRequired":true,"uniqueKey":"availability.items.[INDEX].range_start","typeLabel":"string"},"range_end":{"type":"string","description":"Slot end (ISO 8601).","example":"2024-04-05T17:00:00.000-07:00","isRequired":true,"uniqueKey":"availability.items.[INDEX].range_end","typeLabel":"string"},"provider_id":{"type":"string","description":"EMR provider ID the slot belongs to.","example":"provider-123","isRequired":true,"uniqueKey":"availability.items.[INDEX].provider_id","typeLabel":"string"},"visit_type":{"type":"string","description":"Appointment type bookable in this slot, when the schedule provides one.","example":"New Patient","uniqueKey":"availability.items.[INDEX].visit_type","typeLabel":"string"},"available_appointments":{"type":"integer","description":"Remaining bookable appointments in this slot. Present only when the EHR provides detailed slot capacity.","example":3,"uniqueKey":"availability.items.[INDEX].available_appointments","typeLabel":"integer"},"max_visits":{"type":"integer","description":"Total capacity of this slot. Present only when the EHR provides detailed slot capacity.","example":5,"uniqueKey":"availability.items.[INDEX].max_visits","typeLabel":"integer"},"facility_id":{"type":"string","description":"EMR facility/location ID, when available in the EHR.","example":"1","uniqueKey":"availability.items.[INDEX].facility_id","typeLabel":"string"},"facility_name":{"type":"string","description":"Facility/location name, when available in the EHR.","example":"Main St Clinic","uniqueKey":"availability.items.[INDEX].facility_name","typeLabel":"string"}},"required":["day_of_week","date","duration_string","range_start","range_end","provider_id"],"example":{"day_of_week":5,"date":"2024-04-05","duration_string":"540m","range_start":"2024-04-05T08:00:00.000-07:00","range_end":"2024-04-05T17:00:00.000-07:00","provider_id":"provider-123","visit_type":"New Patient","available_appointments":3,"max_visits":5,"facility_id":"1","facility_name":"Main St Clinic"},"uniqueKey":"availability.items.[INDEX]","typeLabel":"object"},"example":[{"day_of_week":5,"date":"2024-04-05","duration_string":"540m","range_start":"2024-04-05T08:00:00.000-07:00","range_end":"2024-04-05T17:00:00.000-07:00","provider_id":"provider-123","visit_type":"New Patient","available_appointments":3,"max_visits":5,"facility_id":"1","facility_name":"Main St Clinic"}],"isRequired":true,"uniqueKey":"availability","typeLabel":"object[]"},"timezone":{"type":"string","example":"America/Los_Angeles","isRequired":true,"uniqueKey":"timezone","typeLabel":"string"},"warnings":{"type":"array","items":{"type":"string","uniqueKey":"warnings.items.[INDEX]","typeLabel":"string"},"example":[],"uniqueKey":"warnings","typeLabel":"string[]"}},"required":["success","availability","timezone"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"availability":[{"day_of_week":5,"date":"2024-04-05","duration_string":"540m","range_start":"2024-04-05T08:00:00.000-07:00","range_end":"2024-04-05T17:00:00.000-07:00","provider_id":"provider-123","visit_type":"New Patient","available_appointments":3,"max_visits":5,"facility_id":"1","facility_name":"Main St Clinic"}],"timezone":"America/Los_Angeles","warnings":[]}}},"exampleType":"generated"}},"exampleType":"generated"},"412006bf-8c14-45a8-873d-b2b8dbddd248":{"description":"Bad request — missing or invalid parameters","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false],"example":false,"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"message":{"type":"string","example":"Request could not be completed.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["success","message"],"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"message":"Bad request — missing or invalid parameters"},"examples":{"Example":{"title":"Example","value":{"success":false,"message":"Bad request — missing or invalid parameters"}}},"exampleType":"examples"}},"exampleType":"examples"},"f679d7e4-e545-4a89-b3a4-33036f110fd7":{"description":"Unauthorized — missing or invalid credentials","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false],"example":false,"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"message":{"type":"string","example":"Request could not be completed.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["success","message"],"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"message":"Unauthorized — missing or invalid credentials"},"examples":{"Example":{"title":"Example","value":{"success":false,"message":"Unauthorized — missing or invalid credentials"}}},"exampleType":"examples"}},"exampleType":"examples"},"1e56b1a7-1631-498f-8d34-ad74a5c77890":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false],"example":false,"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"message":{"type":"string","example":"Request could not be completed.","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["success","message"],"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"message":"Internal server error"},"examples":{"Example":{"title":"Example","value":{"success":false,"message":"Internal server error"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"c773c563-0c62-4e7f-8e45-5fe0fe8a95c3":{"ClientCredentials":{"type":"apiKey","in":"header","name":"client_id","scopes":[],"schemeName":"ClientCredentials"},"ClientSecret":{"type":"apiKey","in":"header","name":"client_secret","scopes":[],"schemeName":"ClientSecret"},"AccessToken":{"type":"apiKey","in":"header","name":"access_token","scopes":[],"schemeName":"AccessToken"}}},"servers":{"94b8e97d-9613-451e-8654-52265e15f71b":{"url":"https://api.usecobalt.com/v1","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"client_id","scopes":[],"schemeName":"ClientCredentials"},"schema":{"title":"client_id","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ClientCredentials","name":"client_id"},{"scheme":{"type":"apiKey","in":"header","name":"client_secret","scopes":[],"schemeName":"ClientSecret"},"schema":{"title":"client_secret","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ClientSecret","name":"client_secret"},{"scheme":{"type":"apiKey","in":"header","name":"access_token","scopes":[],"schemeName":"AccessToken"},"schema":{"title":"access_token","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"AccessToken","name":"access_token"}],"title":"ClientCredentials \u0026 ClientSecret \u0026 AccessToken"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"cobalt-cd7844c1","siteName":"Cobalt","title":"Get Availability - Cobalt","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-11T19:21:17.183Z","originalFileLocation":"api-reference/availability/get.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Returns open scheduling slots computed from synced provider hours and booked appointments over a date range.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Cobalt\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/cobalt-cd7844c1/dfAt917AjSM3D_ey/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/cobalt-cd7844c1/dfAt917AjSM3D_ey/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/cobalt-cd7844c1/dfAt917AjSM3D_ey/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/cobalt-cd7844c1/dfAt917AjSM3D_ey/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/cobalt-cd7844c1/dfAt917AjSM3D_ey/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/cobalt-cd7844c1/dfAt917AjSM3D_ey/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/cobalt-cd7844c1/dfAt917AjSM3D_ey/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/cobalt-cd7844c1/dfAt917AjSM3D_ey/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/cobalt-cd7844c1/dfAt917AjSM3D_ey/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get Availability - Cobalt\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns open scheduling slots computed from synced provider hours and booked appointments over a date range.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Cobalt\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.usecobalt.com/api-reference/availability/get\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://cobalt-cd7844c1.mintlify.site/_mintlify/api/og/v2?division=Availability\u0026amp;title=Get+Availability\u0026amp;description=Returns+open+scheduling+slots+computed+from+synced+provider+hours+and+booked+appointments+over+a+date+range.\u0026amp;theme=ffc7333b91b15631759a2f94\u0026amp;signature=d451182917bed6cdec1248209f3ab07fcef7b1ba9ec9d0e228fca29641199c00\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get Availability - Cobalt\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns open scheduling slots computed from synced provider hours and booked appointments over a date range.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://cobalt-cd7844c1.mintlify.site/_mintlify/api/og/v2?division=Availability\u0026amp;title=Get+Availability\u0026amp;description=Returns+open+scheduling+slots+computed+from+synced+provider+hours+and+booked+appointments+over+a+date+range.\u0026amp;theme=ffc7333b91b15631759a2f94\u0026amp;signature=d451182917bed6cdec1248209f3ab07fcef7b1ba9ec9d0e228fca29641199c00\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/cobalt-cd7844c1/dfAt917AjSM3D_ey/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Cobalt\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#576dee\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.usecobalt.com/api-reference/availability/get\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/availability/get.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.usecobalt.com/#organization\",\"name\":\"Cobalt\",\"url\":\"https://docs.usecobalt.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/cobalt-cd7844c1/ARV8r_xeyMO_zivG/logo/light.svg?fit=max\u0026auto=format\u0026n=ARV8r_xeyMO_zivG\u0026q=85\u0026s=de8566184dd7d19c926d1f0e5ee04d74\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.usecobalt.com#website\",\"name\":\"Cobalt\",\"url\":\"https://docs.usecobalt.com\",\"publisher\":{\"@id\":\"https://docs.usecobalt.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.usecobalt.com/api-reference/availability/get#webpage\",\"url\":\"https://docs.usecobalt.com/api-reference/availability/get\",\"name\":\"Get Availability\",\"description\":\"Returns open scheduling slots computed from synced provider hours and booked appointments over a date range.\",\"dateModified\":\"2026-09-11T19:21:17.183Z\",\"isPartOf\":{\"@id\":\"https://docs.usecobalt.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.usecobalt.com/api-reference/availability/get#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.usecobalt.com/api-reference/availability/get#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Availability\",\"item\":\"https://docs.usecobalt.com/api-reference/availability/fetch\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Get Availability\",\"item\":\"https://docs.usecobalt.com/api-reference/availability/get\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.usecobalt.com/api-reference/availability/get#apireference\",\"headline\":\"Get Availability\",\"name\":\"Get Availability\",\"description\":\"Returns open scheduling slots computed from synced provider hours and booked appointments over a date range.\",\"url\":\"https://docs.usecobalt.com/api-reference/availability/get\",\"mainEntityOfPage\":{\"@id\":\"https://docs.usecobalt.com/api-reference/availability/get#webpage\"},\"dateModified\":\"2026-09-11T19:21:17.183Z\",\"publisher\":{\"@id\":\"https://docs.usecobalt.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.usecobalt.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Cobalt\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Cobalt\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/availability/get.md","siteName":"Cobalt","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/docs/introduction"}]},{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","href":"/api-reference/introduction"}]},{"group":"Account","pages":[{"title":"Activate Account","openapi":"POST /account/activate","href":"/api-reference/account/activate"},{"title":"Deactivate Account","openapi":"POST /account/deactivate","href":"/api-reference/account/deactivate"},{"title":"Lock Client","openapi":"POST /client/lock","href":"/api-reference/account/lock"},{"title":"Rotate Access Token","openapi":"POST /access-token/rotate","href":"/api-reference/account/rotate-access-token"},{"title":"Disable Credential","openapi":"PATCH /credentials/{credentialId}/disable","href":"/api-reference/account/disable-credential"},{"title":"Enable Credential","openapi":"PATCH /credentials/{credentialId}/enable","href":"/api-reference/account/enable-credential"},{"title":"Delete Credential","openapi":"DELETE /credentials/{credentialId}","href":"/api-reference/account/delete-credential"},{"title":"Get Last Schedule Sync","openapi":"GET /last-schedule-sync","href":"/api-reference/system/last-schedule-sync"}]},{"group":"Appointments","pages":[{"title":"Create Appointments","openapi":"POST /appointments","href":"/api-reference/appointments/create"},{"title":"Fetch Appointments","openapi":"POST /appointments/fetch","href":"/api-reference/appointments/fetch"},{"title":"Get Appointments","openapi":"GET /appointments","href":"/api-reference/appointments/get"},{"title":"Get Appointment by ID","openapi":"GET /appointments/{id}","href":"/api-reference/appointments/get-by-id"},{"title":"Update Appointment","openapi":"PATCH /appointments/{id}","href":"/api-reference/appointments/update"}]},{"group":"Availability","pages":[{"title":"Fetch Availability","openapi":"POST /availability/fetch","description":"Performs a live fetch of provider availability by combining a real-time EMR appointment fetch with availability calculation.","href":"/api-reference/availability/fetch"},{"title":"Get Availability","openapi":"GET /availability","href":"/api-reference/availability/get"}]},{"group":"Claims","pages":[{"title":"Create Claim","openapi":"POST /claims","description":"Creates a claim for a given appointment in the connected EMR system.","href":"/api-reference/claims/create"},{"title":"Get Claims","openapi":"GET /claims","href":"/api-reference/claims/get"},{"title":"Get Claim by ID","openapi":"GET /claims/{id}","href":"/api-reference/claims/get-by-id"},{"title":"Fetch Claims","openapi":"POST /claims/fetch","href":"/api-reference/claims/fetch"}]},{"group":"Codes","pages":[{"title":"Add Diagnosis Codes","openapi":"POST /appointments/{appointment_id}/codes","href":"/api-reference/codes/add"},{"title":"Remove Diagnosis Codes","openapi":"DELETE /appointments/{appointment_id}/codes","href":"/api-reference/codes/remove"}]},{"group":"Documents","pages":[{"title":"List Documents","openapi":"GET /documents","href":"/api-reference/documents/list"},{"title":"Fetch Document","openapi":"POST /documents/fetch","href":"/api-reference/documents/fetch"},{"title":"Get Document","openapi":"GET /documents/{id}","href":"/api-reference/documents/get"},{"title":"Upload Document","openapi":"POST /documents","href":"/api-reference/documents/upload"}]},{"group":"Eligibility","pages":[{"title":"Get Eligibility Checks","openapi":"GET /eligibility-checks","href":"/api-reference/eligibility-checks/get"},{"title":"Get Eligibility Benefits","openapi":"GET /eligibility-checks/{id}/benefits","href":"/api-reference/eligibility-checks/benefits"}]},{"group":"Fee Schedules","pages":[{"title":"Get Fee Schedules","openapi":"GET /fee-schedules","href":"/api-reference/fee-schedules/get"},{"title":"Get Fee Schedule Items","openapi":"GET /fee-schedules/{feeScheduleId}/items","href":"/api-reference/fee-schedules/items"}]},{"group":"Forms","pages":[{"title":"List Forms","openapi":"GET /forms","href":"/api-reference/forms/get"},{"title":"Get Form","openapi":"GET /forms/{id}","href":"/api-reference/forms/get-by-id"},{"title":"Sync Forms","openapi":"POST /forms/fetch","href":"/api-reference/forms/fetch"}]},{"group":"Insurance","pages":[{"title":"Get Insurance Providers","openapi":"GET /insurance-providers","href":"/api-reference/insurance-providers/get"}]},{"group":"Link","pages":[{"title":"Create Link Token","openapi":"POST /link/token/create","href":"/api-reference/link/create-token"},{"title":"Exchange Public Token","openapi":"GET /link/token/exchange","href":"/api-reference/link/exchange-token"}]},{"group":"Locations","pages":[{"title":"Get Locations","openapi":"GET /locations","href":"/api-reference/locations/get"},{"title":"Update Location Status","openapi":"PATCH /locations/{id}","href":"/api-reference/locations/update"}]},{"group":"Messages","pages":[{"title":"Send Message","openapi":"POST /messages","href":"/api-reference/messages/create"}]},{"group":"Notes","pages":[{"title":"Create Note","openapi":"POST /notes","href":"/api-reference/notes/create"}]},{"group":"Orders","pages":[{"title":"Search Order Catalog","openapi":"POST /orders/catalog/fetch","href":"/api-reference/orders/catalog"},{"title":"Create Order","openapi":"POST /orders","href":"/api-reference/orders/create"},{"title":"Get Orders","openapi":"GET /orders","href":"/api-reference/orders/get"},{"title":"Get Order","openapi":"GET /orders/{id}","href":"/api-reference/orders/get-by-id"},{"title":"Update Order","openapi":"PATCH /orders/{id}","href":"/api-reference/orders/update"},{"title":"Create Order Results","openapi":"POST /orders/{id}/results","href":"/api-reference/orders/results"}]},{"group":"Org Settings","pages":[{"title":"Fetch Org Settings","openapi":"POST /org-settings/fetch","href":"/api-reference/org-settings/fetch"}]},{"group":"Patient Notes","pages":[{"title":"Create Patient Note","openapi":"POST /patient-notes","href":"/api-reference/patient-notes/create"}]},{"group":"Patients","pages":[{"title":"Create Patient","openapi":"POST /patients","href":"/api-reference/patients/create"},{"title":"Fetch Patients","openapi":"POST /patients/fetch","href":"/api-reference/patients/fetch"},{"title":"Get Patients","openapi":"GET /patients","href":"/api-reference/patients/get"},{"title":"Update Patient","openapi":"PATCH /patients/{id}","href":"/api-reference/patients/update"},{"group":"Insurance","pages":[{"title":"Add Patient Insurance","openapi":"POST /patients/{patient_mrn}/insurances","href":"/api-reference/patients/insurances/add"},{"title":"Update Patient Insurance","openapi":"PATCH /patients/{patient_mrn}/insurances/{emr_insurance_id}","href":"/api-reference/patients/insurances/update"}]}]},{"group":"Payments","pages":[{"title":"Create Payment","openapi":"POST /payments","href":"/api-reference/payments/create"},{"title":"Get Payments","openapi":"GET /payments","href":"/api-reference/payments/get"},{"title":"Get Payment by ID","openapi":"GET /payments/{id}","href":"/api-reference/payments/get-by-id"}]},{"group":"Pharmacies","pages":[{"title":"Get Pharmacies","openapi":"GET /pharmacies","href":"/api-reference/pharmacies/get"}]},{"group":"Providers","pages":[{"title":"Get Providers","openapi":"GET /providers","href":"/api-reference/providers/get"},{"title":"Update Provider","openapi":"PATCH /providers/{id}","href":"/api-reference/providers/update"},{"title":"Update Provider by EMR ID","openapi":"PATCH /providers/ehr/{ehr_id}","href":"/api-reference/providers/update-by-ehr"}]},{"group":"Recalls","pages":[{"title":"Get Recalls","openapi":"GET /recalls","href":"/api-reference/recalls/list"},{"title":"Create Recall","openapi":"POST /recalls","href":"/api-reference/recalls/create"},{"title":"Update Recall","openapi":"PATCH /recalls/{id}","href":"/api-reference/recalls/update"},{"title":"Add Action to Recall","openapi":"POST /recalls/{id}/actions","href":"/api-reference/recalls/create-action"}]},{"group":"Referrals","pages":[{"title":"Create Referral","openapi":"POST /referrals","href":"/api-reference/referrals/create"},{"title":"Get Referrals","openapi":"GET /referrals","href":"/api-reference/referrals/get"},{"title":"Update Referral","openapi":"PATCH /referrals/{id}","href":"/api-reference/referrals/update"}]},{"group":"Referring Providers","pages":[{"title":"Create Referring Provider","openapi":"POST /referring-providers","href":"/api-reference/referring-providers/create"},{"title":"Get Referring Providers","openapi":"GET /referring-providers","href":"/api-reference/referring-providers/get"}]},{"group":"Encounters","pages":[{"title":"Create Encounter","openapi":"POST /encounters","href":"/api-reference/encounters/create"},{"title":"Update Encounter","openapi":"PATCH /encounters/{id}","href":"/api-reference/encounters/update"}]},{"group":"Settings","pages":[{"title":"Get Settings","openapi":"GET /settings","href":"/api-reference/settings/get"},{"title":"Update Settings","openapi":"POST /settings","href":"/api-reference/settings/update"}]},{"group":"Staff","pages":[{"title":"Get Staff","openapi":"GET /staff","href":"/api-reference/staff/get"}]},{"group":"Tasks","pages":[{"title":"Create Task","openapi":"POST /tasks","href":"/api-reference/tasks/create"},{"title":"Create Task Note","openapi":"POST /tasks/notes","href":"/api-reference/tasks/notes/create"}]},{"group":"Telephone Encounters","pages":[{"title":"List Telephone Encounters","openapi":"GET /telephone-encounters","href":"/api-reference/telephone-encounters/list"},{"title":"Create Telephone Encounter","openapi":"POST /telephone-encounters","href":"/api-reference/telephone-encounters/create"},{"title":"Add Action to Telephone Encounter","openapi":"POST /telephone-encounters/actions","href":"/api-reference/telephone-encounters/create-action"}]},{"group":"Visit Statuses","pages":[{"title":"Get Visit Statuses","openapi":"GET /visit-statuses","href":"/api-reference/visit-statuses/get"}]},{"group":"Visit Types","pages":[{"title":"Get Visit Types","openapi":"GET /visit-types","href":"/api-reference/visit-types/get"}]},{"group":"Webhooks","pages":[{"title":"Create Webhook","openapi":"POST /webhook","href":"/api-reference/webhooks/create"},{"title":"Delete Webhook","openapi":"DELETE /webhook/{id}","href":"/api-reference/webhooks/delete"},{"title":"Get Webhooks","openapi":"GET /webhook","href":"/api-reference/webhooks/get"},{"title":"Rotate Webhook Secret","openapi":"POST /webhook/rotate-secret","href":"/api-reference/webhooks/rotate-secret"},{"title":"Send Test Webhook","openapi":"POST /webhook/test","href":"/api-reference/webhooks/send-test-webhook"},{"title":"Get Webhook Events","openapi":"GET /webhook-events","href":"/api-reference/webhook-events/get"},{"title":"Get Webhook Event","openapi":"GET /webhook-events/{id}","href":"/api-reference/webhook-events/get-by-id"}]}]}]},"basePath":"","title":"Get Availability - Cobalt","buildId":"dpl_596ePT575z4qnAFksq1biRW97aLY","deploymentId":"dpl_596ePT575z4qnAFksq1biRW97aLY","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C9Wu0MeN.js","utils-jWgu-6Qf.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DBD8f9qn.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BGuX1ui5.js","snippetPresets-Evy63nQB.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BQHO1lnV.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-B6C8m-t_.js","shallow-BG4cT0fH.js","getApiPlaygroundDisplay-CgEPrE-D.js","CodeSnippet-CU8JyZ9N.js","CodeSnippets-BnxHU32T.js","Page-D6S0Yh6q.js","getPastedJson-CwiYOonh.js","icon-DYDpWmDf.js","MethodPill-C-J-l7_c.js","DuplicateIcon-B6ARwg9w.js","createIcon-Dsv4MtDq.js","DynamicMarkdown-CtasenyM.js","SectionHeading-YNcgYwjB.js","axios-vUo_bRtp.js","Markdown-CwLx6PAg.js","clsx-C3kuh_dz.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CmKHfscc.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-U3mI6Ljh.js"]}