{"items":[{"type":"link","label":"API Documentation","link":"/apis","routeSlug":"/apis","content":{"contentType":"overview","meta":{"name":"API Documentation"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"index.json","url":"/_bundle/apis/index.json?download"},{"kind":"download","label":"index.yaml","url":"/_bundle/apis/index.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"API Documentation (1.177)","showPageActions":true}],"sectionId":"/apis"}]}]}},{"type":"group","label":"NPIs","link":"/apis/reference","routeSlug":"/apis/reference","items":[{"label":"Get active provider NPIs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/reference/getprovidernpis","routeSlug":"/apis/reference/getprovidernpis","metadata":{"seo":{"title":"Get active provider NPIs","description":"Retrieves the list of active provider NPIs within the developer's Zocdoc directory. The NPIs retrieved here can be used to search for providers in the /v1/providers endpoint to facilitate availability, discovery, and booking."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProviderNpis","name":"Get active provider NPIs","isWebhook":false,"pointer":"/paths/~1v1~1reference~1npi/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get active provider NPIs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the list of active provider NPIs within the developer's Zocdoc directory. The NPIs retrieved here can be used to search for providers in the /v1/providers endpoint to facilitate availability, discovery, and booking.\n\nDevelopers can fetch the NPI list and cache in their system. The available NPIs do not change frequently. Pulling this data once a week and/or after known directory change events should be sufficient.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsFlow","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Machine to machine authentication (for use from client server to Zocdoc)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com/oauth/token"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com/oauth/token"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}]},{"schemes":[{"name":"AuthorizationCodeFlow","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Log in as a user. Client Secret is not necessary for this login flow."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com"},"children":[]}]}]}],"flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_38","description":"The zero indexed page of results. A mimimum value of 0 will be accepted."},{"name":"page_size","in":"query","schemaId":"schema_38","description":"The number of results to return per page. A mimimum value of 1 and a maximum of 60000 will be accepted."}],"pointer":"/paths/~1v1~1reference~1npi/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/reference/npi","servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","schemaId":"schema_38"},{"name":"page_size","in":"query","schemaId":"schema_38"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsFlow","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}],"scopes":[]},{"schemes":[{"id":"AuthorizationCodeFlow","type":"oauth2","flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/v1/reference/npi","href":"reference/getprovidernpis","openApiOperationId":"getProviderNpis","summary":"Get active provider NPIs","securityGroups":[{"ClientCredentialsFlow":[]},{"AuthorizationCodeFlow":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProviderNpiResponse"}},"schemaId":"components/schemas/ProviderNpiResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}},"schemaId":"components/schemas/ErrorResult"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"}],"pointer":"/paths/~1v1~1reference~1npi/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProviderNpiResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProviderNpiResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}}},{"code":"401"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reference/getprovidernpis"}],"panels":[]}]},"httpPath":"/v1/reference/npi"}],"content":{"contentType":"group","meta":{"name":"reference"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"NPIs","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints to retrieve active provider NPIs within the developer's directory."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/reference/npi","summary":"Get active provider NPIs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reference/getprovidernpis","deprecated":false}]}]}]}]}},{"type":"group","label":"Directory Management","link":"/apis/schedulable-entities","routeSlug":"/apis/schedulable-entities","items":[{"label":"Get schedulable entities","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/schedulable-entities/getschedulableentities","routeSlug":"/apis/schedulable-entities/getschedulableentities","metadata":{"seo":{"title":"Get schedulable entities","description":"Get the list of schedulable entities within the developer's Zocdoc directory (provider-locations, etc.) with availability information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSchedulableEntities","name":"Get schedulable entities","isWebhook":false,"pointer":"/paths/~1v1~1schedulable_entities/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get schedulable entities","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get the list of schedulable entities within the developer's Zocdoc directory (provider-locations, etc.) with availability information."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NPIs can be used to search for providers in the /v1/providers endpoint to facilitate availability, discovery, and booking. Schedulable entity ids can be used to find provider-locations in the /v1/provider_locations/{provider_location_id} endpoint to facilitate availability, discovery, and booking."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Developers can fetch the schedulable entities list and cache in their system. The available schedulable entities do not change frequently. Pulling this data once a week and/or after known directory change events should be sufficient. However, you may use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recent_changes_72hrs"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recent_change_summary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field to get the list of entities that have changed in the last 72 hours."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsFlow","scopes":["external.schedulable_entity.read"],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Machine to machine authentication (for use from client server to Zocdoc)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com/oauth/token"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com/oauth/token"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}]},{"schemes":[{"name":"AuthorizationCodeFlow","scopes":["external.schedulable_entity.read"],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Log in as a user. Client Secret is not necessary for this login flow."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com"},"children":[]}]}]}],"flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_38","description":"The zero indexed page of results. A mimimum value of 0 will be accepted."},{"name":"page_size","in":"query","schemaId":"schema_39","description":"The number of results to return per page. The default value is 5000. A mimimum value of 1 and a maximum of 10000 will be accepted."},{"name":"schedule_types","in":"query","schemaId":"schema_40","description":"The comma-delimited list of schedule types to include. Will return all schedule types if not provided."},{"name":"recent_changes_72hrs","in":"query","schemaId":"schema_41","description":"When true, only includes entities added or updated in the last 72 hours"}],"pointer":"/paths/~1v1~1schedulable_entities/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/schedulable_entities","servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_38"},{"name":"page_size","in":"query","required":false,"schemaId":"schema_39"},{"name":"schedule_types","in":"query","required":false,"schemaId":"schema_40"},{"name":"recent_changes_72hrs","in":"query","required":false,"schemaId":"schema_41"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsFlow","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}],"scopes":["external.schedulable_entity.read"]},{"schemes":[{"id":"AuthorizationCodeFlow","type":"oauth2","flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}],"scopes":["external.schedulable_entity.read"]}],"responseCodes":["200","400","401","403"],"pointer":"/v1/schedulable_entities","href":"schedulable-entities/getschedulableentities","openApiOperationId":"getSchedulableEntities","summary":"Get schedulable entities","securityGroups":[{"ClientCredentialsFlow":["external.schedulable_entity.read"]},{"AuthorizationCodeFlow":["external.schedulable_entity.read"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SchedulableEntitiesResponse"}},"schemaId":"components/schemas/SchedulableEntitiesResponse"},{"code":"400","description":"Invalid request parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}},"schemaId":"components/schemas/ErrorResult"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"}],"pointer":"/paths/~1v1~1schedulable_entities/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SchedulableEntitiesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SchedulableEntitiesResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}}},{"code":"401"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/schedulable-entities/getschedulableentities"}],"panels":[]}]},"httpPath":"/v1/schedulable_entities"},{"label":"Submit NPI overlaps","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/schedulable-entities/putschedulableentitiesoverlaps","routeSlug":"/apis/schedulable-entities/putschedulableentitiesoverlaps","metadata":{"seo":{"title":"Submit NPI overlaps","description":"Submit NPI overlaps to compare your provider directory with providersbookable on Zocdoc. Send real-time distribution status(developer_app_state), unverified addresses and other data requiredfor joint provider operations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"putSchedulableEntitiesOverlaps","name":"Submit NPI overlaps","isWebhook":false,"pointer":"/paths/~1v1~1schedulable_entities~1overlaps/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submit NPI overlaps","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Submit NPI overlaps to compare your provider directory with providers"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"bookable on Zocdoc. Send real-time distribution status"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"developer_app_state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), unverified addresses and other data required"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for joint provider operations."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsFlow","scopes":["external.schedulable_entity.read"],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Machine to machine authentication (for use from client server to Zocdoc)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com/oauth/token"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com/oauth/token"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}]},{"schemes":[{"name":"AuthorizationCodeFlow","scopes":["external.schedulable_entity.read"],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Log in as a user. Client Secret is not necessary for this login flow."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com"},"children":[]}]}]}],"flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SchedulableEntitiesOverlapsRequestBody"}},"schemaId":"components/schemas/SchedulableEntitiesOverlapsRequestBody","pointer":"/paths/~1v1~1schedulable_entities~1overlaps/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/schedulable_entities/overlaps","servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsFlow","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}],"scopes":["external.schedulable_entity.read"]},{"schemes":[{"id":"AuthorizationCodeFlow","type":"oauth2","flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}],"scopes":["external.schedulable_entity.read"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SchedulableEntitiesOverlapsRequestBody"}},"responseCodes":["200","400","401","403"],"pointer":"/v1/schedulable_entities/overlaps","href":"schedulable-entities/putschedulableentitiesoverlaps","openApiOperationId":"putSchedulableEntitiesOverlaps","summary":"Submit NPI overlaps","securityGroups":[{"ClientCredentialsFlow":["external.schedulable_entity.read"]},{"AuthorizationCodeFlow":["external.schedulable_entity.read"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"schemaId":"components/schemas/SchedulableEntitiesOverlapsRequestBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SchedulableEntitiesOverlapsRequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SchedulableEntitiesOverlapsResponseBody"}},"schemaId":"components/schemas/SchedulableEntitiesOverlapsResponseBody"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}},"schemaId":"components/schemas/ErrorResult"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"}],"pointer":"/paths/~1v1~1schedulable_entities~1overlaps/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SchedulableEntitiesOverlapsResponseBody","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SchedulableEntitiesOverlapsResponseBody"}}},{"code":"400","schemaId":"components/schemas/ErrorResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}}},{"code":"401"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/schedulable-entities/putschedulableentitiesoverlaps"}],"panels":[]}]},"httpPath":"/v1/schedulable_entities/overlaps"}],"content":{"contentType":"group","meta":{"name":"schedulable-entities"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Directory Management","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints to manage the providers in the developer's directory. Retrieve the schedulable entities currently in your directory with availability information, or submit a list of NPIs to determine which of those providers are already schedulable."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/schedulable_entities","summary":"Get schedulable entities","prefix":{"name":"get","color":"get"},"badges":[],"link":"/schedulable-entities/getschedulableentities","deprecated":false},{"title":"/v1/schedulable_entities/overlaps","summary":"Submit NPI overlaps","prefix":{"name":"put","color":"put"},"badges":[],"link":"/schedulable-entities/putschedulableentitiesoverlaps","deprecated":false}]}]}]}]}},{"type":"group","label":"Insurance","link":"/apis/insurance-reference","routeSlug":"/apis/insurance-reference","items":[{"label":"Get insurance plans","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/insurance-reference/getinsuranceplans","routeSlug":"/apis/insurance-reference/getinsuranceplans","metadata":{"seo":{"title":"Get insurance plans","description":"Get insurance plans"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getInsurancePlans","name":"Get insurance plans","isWebhook":false,"pointer":"/paths/~1v1~1insurance_plans/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get insurance plans","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get insurance plans"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsFlow","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Machine to machine authentication (for use from client server to Zocdoc)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com/oauth/token"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com/oauth/token"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}]},{"schemes":[{"name":"AuthorizationCodeFlow","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Log in as a user. Client Secret is not necessary for this login flow."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com"},"children":[]}]}]}],"flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_42","description":"The zero indexed page of results."},{"name":"page_size","in":"query","schemaId":"schema_43","description":"The number of results to return per page. Default is 100."},{"name":"status","in":"query","schemaId":"schema_44","description":"The status of the insurance plan. Default is active."},{"name":"state","in":"query","schemaId":"schema_45","description":"The two letter State code where the insurance plan has coverage."},{"name":"network_type","in":"query","schemaId":"schema_46","description":"The network type of the insurance plan."},{"name":"program_type","in":"query","schemaId":"schema_47","description":"The program type of the insurance plan."},{"name":"care_category","in":"query","schemaId":"schema_48","description":"The care type of the insurance plan."}],"pointer":"/paths/~1v1~1insurance_plans/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/insurance_plans","servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","schemaId":"schema_42"},{"name":"page_size","in":"query","schemaId":"schema_43"},{"name":"status","in":"query","schemaId":"components/schemas/InsuranceStatus"},{"name":"state","in":"query","example":"NY","schemaId":"schema_45"},{"name":"network_type","in":"query","schemaId":"components/schemas/InsuranceNetworkType"},{"name":"program_type","in":"query","schemaId":"components/schemas/InsuranceProgramType"},{"name":"care_category","in":"query","schemaId":"components/schemas/CareCategory"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsFlow","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}],"scopes":[]},{"schemes":[{"id":"AuthorizationCodeFlow","type":"oauth2","flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/v1/insurance_plans","href":"insurance-reference/getinsuranceplans","openApiOperationId":"getInsurancePlans","summary":"Get insurance plans","securityGroups":[{"ClientCredentialsFlow":[]},{"AuthorizationCodeFlow":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InsurancePlansResponse"}},"schemaId":"components/schemas/InsurancePlansResponse"},{"code":"400","description":"Invalid request parameters.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}},"schemaId":"components/schemas/ErrorResult"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not found"}],"pointer":"/paths/~1v1~1insurance_plans/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/InsurancePlansResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InsurancePlansResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}}},{"code":"401"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/insurance-reference/getinsuranceplans"}],"panels":[]}]},"httpPath":"/v1/insurance_plans"},{"label":"Get insurance plan by id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/insurance-reference/getinsuranceplan","routeSlug":"/apis/insurance-reference/getinsuranceplan","metadata":{"seo":{"title":"Get insurance plan by id","description":"Get insurance plan by id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getInsurancePlan","name":"Get insurance plan by id","isWebhook":false,"pointer":"/paths/~1v1~1insurance_plans~1{insurance_plan_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get insurance plan by id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get insurance plan by id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsFlow","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Machine to machine authentication (for use from client server to Zocdoc)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com/oauth/token"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com/oauth/token"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}]},{"schemes":[{"name":"AuthorizationCodeFlow","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Log in as a user. Client Secret is not necessary for this login flow."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com"},"children":[]}]}]}],"flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"insurance_plan_id","in":"path","schemaId":"schema_49","description":"Zocdoc insurance plan id","required":true}],"pointer":"/paths/~1v1~1insurance_plans~1{insurance_plan_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/insurance_plans/{insurance_plan_id}","servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"parameters":{"path":[{"name":"insurance_plan_id","in":"path","required":true,"example":"ip_31820","schemaId":"schema_49"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsFlow","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}],"scopes":[]},{"schemes":[{"id":"AuthorizationCodeFlow","type":"oauth2","flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/v1/insurance_plans/{insurance_plan_id}","href":"insurance-reference/getinsuranceplan","openApiOperationId":"getInsurancePlan","summary":"Get insurance plan by id","securityGroups":[{"ClientCredentialsFlow":[]},{"AuthorizationCodeFlow":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InsurancePlanByIdResponse"}},"schemaId":"components/schemas/InsurancePlanByIdResponse"},{"code":"400","description":"Invalid request parameters.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}},"schemaId":"components/schemas/ErrorResult"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not found"}],"pointer":"/paths/~1v1~1insurance_plans~1{insurance_plan_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/InsurancePlanByIdResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/InsurancePlanByIdResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}}},{"code":"401"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/insurance-reference/getinsuranceplan"}],"panels":[]}]},"httpPath":"/v1/insurance_plans/{insurance_plan_id}"}],"content":{"contentType":"group","meta":{"name":"insurance-reference"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Insurance","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints to retrieve insurance plans supported by Zocdoc."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/insurance_plans","summary":"Get insurance plans","prefix":{"name":"get","color":"get"},"badges":[],"link":"/insurance-reference/getinsuranceplans","deprecated":false},{"title":"/v1/insurance_plans/{insurance_plan_id}","summary":"Get insurance plan by id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/insurance-reference/getinsuranceplan","deprecated":false}]}]}]}]}},{"type":"group","label":"Providers","link":"/apis/providers","routeSlug":"/apis/providers","items":[{"label":"Get providers by NPIs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/providers/getproviders","routeSlug":"/apis/providers/getproviders","metadata":{"seo":{"title":"Get providers by NPIs","description":"Retrieves specific providers within the developer's directory by NPI search. This endpoint searches active providers that are listed on Zocdoc. It returns the provider's information (such as name, gender identity, specialty), location information and provider location IDs which can be used to look up availability and book appointments. Every developer has a designated provider directory jointly defined and onboarded in partnership with Zocdoc."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProviders","name":"Get providers by NPIs","isWebhook":false,"pointer":"/paths/~1v1~1providers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get providers by NPIs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves specific providers within the developer's directory by NPI search. This endpoint searches active providers that are listed on Zocdoc. It returns the provider's information (such as name, gender identity, specialty), location information and provider location IDs which can be used to look up availability and book appointments. Every developer has a designated provider directory jointly defined and onboarded in partnership with Zocdoc."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"provider_location_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returned in the response can be used to retrieve availability in the endpoint /v1/provider_locations/availability."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsFlow","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Machine to machine authentication (for use from client server to Zocdoc)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com/oauth/token"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com/oauth/token"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}]},{"schemes":[{"name":"AuthorizationCodeFlow","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Log in as a user. Client Secret is not necessary for this login flow."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com"},"children":[]}]}]}],"flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"npis","in":"query","schemaId":"schema_50","description":"A comma-delimited list of Provider NPI numbers. A maximum of 50 items will be accepted at a time.","required":true},{"name":"insurance_plan_id","in":"query","schemaId":"schema_49","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Zocdoc ID of the patient's insurance plan. Used to determine if provider takes patient's insurance in response. Use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/getInsurancePlans"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get Insurance Plans"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint to retrieve available plans."},"children":[]}]}]}]},{"name":"latitude","in":"query","schemaId":"schema_51","description":"Latitude of the patient's location. Must be provided together with longitude. When provided, response includes distance and nearest match for each physical location."},{"name":"longitude","in":"query","schemaId":"schema_52","description":"Longitude of the patient's location. Must be provided together with latitude. When provided, response includes distance and nearest match for each physical location."}],"pointer":"/paths/~1v1~1providers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/providers","servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"parameters":{"path":[],"query":[{"name":"npis","in":"query","required":true,"example":"1234567891,0123456789","schemaId":"schema_50"},{"name":"insurance_plan_id","in":"query","required":false,"example":"ip_31820","schemaId":"schema_49"},{"name":"latitude","in":"query","required":false,"schemaId":"schema_51"},{"name":"longitude","in":"query","required":false,"schemaId":"schema_52"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsFlow","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}],"scopes":[]},{"schemes":[{"id":"AuthorizationCodeFlow","type":"oauth2","flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/v1/providers","href":"providers/getproviders","openApiOperationId":"getProviders","summary":"Get providers by NPIs","securityGroups":[{"ClientCredentialsFlow":[]},{"AuthorizationCodeFlow":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProviderResult"}},"schemaId":"components/schemas/ProviderResult"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}},"schemaId":"components/schemas/ErrorResult"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"}],"pointer":"/paths/~1v1~1providers/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProviderResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProviderResult"}}},{"code":"400","schemaId":"components/schemas/ErrorResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}}},{"code":"401"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/providers/getproviders"}],"panels":[]}]},"httpPath":"/v1/providers"}],"content":{"contentType":"group","meta":{"name":"providers"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Providers","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints to retrieve providers within the developer's directory."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/providers","summary":"Get providers by NPIs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/providers/getproviders","deprecated":false}]}]}]}]}},{"type":"group","label":"Provider locations","link":"/apis/provider-locations","routeSlug":"/apis/provider-locations","items":[{"label":"Get provider locations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/provider-locations/getproviderlocations","routeSlug":"/apis/provider-locations/getproviderlocations","metadata":{"seo":{"title":"Get provider locations","description":"This endpoint accepts parameters such as zip code, specialty, visit reason and accepted insurance to return a filtered set of providers within the developer's directory. The response includes additional information about the provider location objects returned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProviderLocations","name":"Get provider locations","isWebhook":false,"pointer":"/paths/~1v1~1provider_locations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get provider locations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint accepts parameters such as zip code, specialty, visit reason and accepted insurance to return a filtered set of providers within the developer's directory. The response includes additional information about the provider location objects returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"provider_location_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returned in the response can be used to retrieve availability in the endpoint /v1/provider_locations/availability."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsFlow","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Machine to machine authentication (for use from client server to Zocdoc)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com/oauth/token"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com/oauth/token"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}]},{"schemes":[{"name":"AuthorizationCodeFlow","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Log in as a user. Client Secret is not necessary for this login flow."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com"},"children":[]}]}]}],"flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"zip_code","in":"query","schemaId":"schema_53","description":"A 5 digit zip code."},{"name":"latitude","in":"query","schemaId":"schema_51","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Latitude of the search location, in decimal degrees. Must be provided together with longitude. Used only when zip_code is not supplied; zip_code takes precedence over the pair."},"children":[]}]}]}]},{"name":"longitude","in":"query","schemaId":"schema_52","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Longitude of the search location, in decimal degrees. Must be provided together with latitude. Used only when zip_code is not supplied; zip_code takes precedence over the pair."},"children":[]}]}]}]},{"name":"specialty_id","in":"query","schemaId":"schema_54","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Zocdoc ID of the provider's specialty. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/reference-data"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reference Data"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for options. One of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specialty_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"visit_reason_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"visit_reason_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not supplied, the default visit reason for the specialty will be used."},"children":[]}]}]}]},{"name":"visit_reason_id","in":"query","schemaId":"schema_55","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Zocdoc ID for the visit reason. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/reference-data"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reference Data"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for options. One of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specialty_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"visit_reason_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required. If both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"visit_reason_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"specialty_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are supplied, the specialty must be the visit reason's corresponding specialty."},"children":[]}]}]}]},{"name":"page","in":"query","schemaId":"schema_38","description":"The zero indexed page of results."},{"name":"page_size","in":"query","schemaId":"schema_38","description":"The number of results to return per page."},{"name":"insurance_plan_id","in":"query","schemaId":"schema_49","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Zocdoc ID of the patient's insurance plan. Use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/getInsurancePlans"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get Insurance Plans"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint to retrieve available plans."},"children":[]}]}]}]},{"name":"visit_type","in":"query","schemaId":"schema_56","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of patient visit with the provider. If not provided, the default value is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"in_person"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"max_distance_to_patient_mi","in":"query","schemaId":"schema_57","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum distance in miles from the physical location to the search location (the center point of the given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"zip_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Defaults to 50 miles, which is also the widest radius available."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1provider_locations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/provider_locations","servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"parameters":{"path":[],"query":[{"name":"zip_code","in":"query","required":false,"example":36925,"schemaId":"schema_53"},{"name":"latitude","in":"query","required":false,"schemaId":"schema_51"},{"name":"longitude","in":"query","required":false,"schemaId":"schema_52"},{"name":"specialty_id","in":"query","example":"sp_153","schemaId":"schema_54"},{"name":"visit_reason_id","in":"query","example":"pc_FRO-18leckytNKtruw5dLR","schemaId":"schema_55"},{"name":"page","in":"query","schemaId":"schema_38"},{"name":"page_size","in":"query","schemaId":"schema_38"},{"name":"insurance_plan_id","in":"query","required":false,"example":"ip_31820","schemaId":"schema_49"},{"name":"visit_type","in":"query","required":false,"example":"all","schemaId":"components/schemas/VisitType"},{"name":"max_distance_to_patient_mi","in":"query","required":false,"schemaId":"schema_57"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsFlow","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}],"scopes":[]},{"schemes":[{"id":"AuthorizationCodeFlow","type":"oauth2","flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","409"],"pointer":"/v1/provider_locations","href":"provider-locations/getproviderlocations","openApiOperationId":"getProviderLocations","summary":"Get provider locations","securityGroups":[{"ClientCredentialsFlow":[]},{"AuthorizationCodeFlow":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Succesful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProviderListResult"}},"schemaId":"components/schemas/ProviderListResult"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}},"schemaId":"components/schemas/ErrorResult"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}},"schemaId":"components/schemas/ErrorResult"}],"pointer":"/paths/~1v1~1provider_locations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProviderListResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProviderListResult"}}},{"code":"400","schemaId":"components/schemas/ErrorResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}}},{"code":"401"},{"code":"403"},{"code":"409","schemaId":"components/schemas/ErrorResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/provider-locations/getproviderlocations"}],"panels":[]}]},"httpPath":"/v1/provider_locations"},{"label":"Get provider location by id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/provider-locations/getproviderlocation","routeSlug":"/apis/provider-locations/getproviderlocation","metadata":{"seo":{"title":"Get provider location by id","description":"Get info about a provider location by provider_location_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProviderLocation","name":"Get provider location by id","isWebhook":false,"pointer":"/paths/~1v1~1provider_locations~1{provider_location_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get provider location by id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get info about a provider location by provider_location_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsFlow","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Machine to machine authentication (for use from client server to Zocdoc)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com/oauth/token"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com/oauth/token"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}]},{"schemes":[{"name":"AuthorizationCodeFlow","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Log in as a user. Client Secret is not necessary for this login flow."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com"},"children":[]}]}]}],"flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"provider_location_id","in":"path","schemaId":"schema_58","description":"The Zocdoc provider location id to get details for.","required":true}],"pointer":"/paths/~1v1~1provider_locations~1{provider_location_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"insurance_plan_id","in":"query","schemaId":"schema_49","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Zocdoc ID of the patient's insurance plan. Use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/getInsurancePlans"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get Insurance Plans"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint to retrieve available plans."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1provider_locations~1{provider_location_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/provider_locations/{provider_location_id}","servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"parameters":{"path":[{"name":"provider_location_id","in":"path","required":true,"example":"pr_abc123-def456_wxyz7890|lo_abc123-def456_wxyz7890","schemaId":"schema_58"}],"query":[{"name":"insurance_plan_id","in":"query","required":false,"example":"ip_31820","schemaId":"schema_49"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsFlow","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}],"scopes":[]},{"schemes":[{"id":"AuthorizationCodeFlow","type":"oauth2","flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/v1/provider_locations/{provider_location_id}","href":"provider-locations/getproviderlocation","openApiOperationId":"getProviderLocation","summary":"Get provider location by id","securityGroups":[{"ClientCredentialsFlow":[]},{"AuthorizationCodeFlow":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProviderLocationResult"}},"schemaId":"components/schemas/ProviderLocationResult"},{"code":"400","description":"Invalid request parameters.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}},"schemaId":"components/schemas/ErrorResult"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}},"schemaId":"components/schemas/ErrorResult"},{"code":"404","description":"Provider location not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}},"schemaId":"components/schemas/ErrorResult"}],"pointer":"/paths/~1v1~1provider_locations~1{provider_location_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProviderLocationResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProviderLocationResult"}}},{"code":"400","schemaId":"components/schemas/ErrorResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}}},{"code":"404","schemaId":"components/schemas/ErrorResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/provider-locations/getproviderlocation"}],"panels":[]}]},"httpPath":"/v1/provider_locations/{provider_location_id}"},{"label":"Get availability for provider locations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/provider-locations/getproviderlocationsavailability","routeSlug":"/apis/provider-locations/getproviderlocationsavailability","metadata":{"seo":{"title":"Get availability for provider locations","description":"Retrieves availability for a set of provider locations. Required parameters passed include provider location ids, visit reason id and patient type. Visit reason and patient type (new or existing) are used to calculate the duration of the appointment and break availability into bookable timeslots based on the appointment duration. The response output includes the start times of appointments based on these calculations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProviderLocationsAvailability","name":"Get availability for provider locations","isWebhook":false,"pointer":"/paths/~1v1~1provider_locations~1availability/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get availability for provider locations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves availability for a set of provider locations. Required parameters passed include provider location ids, visit reason id and patient type. Visit reason and patient type (new or existing) are used to calculate the duration of the appointment and break availability into bookable timeslots based on the appointment duration. The response output includes the start times of appointments based on these calculations."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returned is used in the endpoint /v1/appointments to book appointments."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no timeslots are available that satisfy the parameters, an empty array will be returned for that Provider Location's timeslots."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsFlow","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Machine to machine authentication (for use from client server to Zocdoc)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com/oauth/token"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com/oauth/token"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}]},{"schemes":[{"name":"AuthorizationCodeFlow","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Log in as a user. Client Secret is not necessary for this login flow."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com"},"children":[]}]}]}],"flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"provider_location_ids","in":"query","schemaId":"schema_59","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A comma-delimited list of Zocdoc "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"provider_location_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" retrieved from the /v1/providers or /v1/provider_locations endpoint. A maximum of 50 items will be accepted at a time."},"children":[]}]}]}],"required":true},{"name":"visit_reason_id","in":"query","schemaId":"schema_55","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Zocdoc ID of the visit reason. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/reference-data"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reference Data"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for options."},"children":[]}]}]}],"required":true},{"name":"patient_type","in":"query","schemaId":"schema_60","description":"New or existing to indicate if the patient is new to the practice or has been to the office before.","required":true},{"name":"start_date_in_provider_local_time","in":"query","schemaId":"schema_61","description":"The first date to retrieve availability for, as YYYY-MM-DD. Defaults to current date in US Eastern Time. Can request availability up to a maximum of 150 days into the future."},{"name":"end_date_in_provider_local_time","in":"query","schemaId":"schema_61","description":"The last inclusive date to retrieve availability for, as YYYY-MM-DD. Defaults to 7 days after the current date. Must be 31 days or less after the start date."},{"name":"published_context","in":"query","schemaId":"schema_62","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines how availability slots are returned. Direct_listing returns all slots, while condition_driven_search limits results to Zocdoc-active providers with budget. Applicable to syndication clients."},"children":[]}]}]}]},{"name":"insurance_plan_id","in":"query","schemaId":"schema_40","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Zocdoc ID of the patient's insurance plan. Use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/getInsurancePlans"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get Insurance Plans"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint to retrieve available plans. Used to construct booking_url."},"children":[]}]}]}]},{"name":"insurance_carrier_id","in":"query","schemaId":"schema_40","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Zocdoc ID of the patient's insurance carrier. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/reference-data"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reference Data"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for options. Used to construct booking_url."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1provider_locations~1availability/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/provider_locations/availability","servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"parameters":{"path":[],"query":[{"name":"provider_location_ids","in":"query","required":true,"example":"pr_abc123-def456_wxyz7890|lo_abc123-def456_wxyz7890,pr_ghi123-jkl456_mnop7890|lo_ghi123-jkl456_mnop7890","schemaId":"schema_59"},{"name":"visit_reason_id","in":"query","required":true,"example":"pc_FRO-18leckytNKtruw5dLR","schemaId":"schema_55"},{"name":"patient_type","in":"query","required":true,"example":"new","schemaId":"components/schemas/PatientType"},{"name":"start_date_in_provider_local_time","in":"query","schemaId":"schema_61"},{"name":"end_date_in_provider_local_time","in":"query","schemaId":"schema_61"},{"name":"published_context","in":"query","required":false,"schemaId":"components/schemas/PublishedContext"},{"name":"insurance_plan_id","in":"query","required":false,"schemaId":"schema_40"},{"name":"insurance_carrier_id","in":"query","required":false,"schemaId":"schema_40"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsFlow","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}],"scopes":[]},{"schemes":[{"id":"AuthorizationCodeFlow","type":"oauth2","flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409"],"pointer":"/v1/provider_locations/availability","href":"provider-locations/getproviderlocationsavailability","openApiOperationId":"getProviderLocationsAvailability","summary":"Get availability for provider locations","securityGroups":[{"ClientCredentialsFlow":[]},{"AuthorizationCodeFlow":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AvailabilityResult"}},"schemaId":"components/schemas/AvailabilityResult"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}},"schemaId":"components/schemas/ErrorResult"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}},"schemaId":"components/schemas/ErrorResult"},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}},"schemaId":"components/schemas/ErrorResult"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}},"schemaId":"components/schemas/ErrorResult"}],"pointer":"/paths/~1v1~1provider_locations~1availability/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AvailabilityResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AvailabilityResult"}}},{"code":"400","schemaId":"components/schemas/ErrorResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}}},{"code":"401"},{"code":"403","schemaId":"components/schemas/ErrorResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}}},{"code":"404","schemaId":"components/schemas/ErrorResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}}},{"code":"409","schemaId":"components/schemas/ErrorResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/provider-locations/getproviderlocationsavailability"}],"panels":[]}]},"httpPath":"/v1/provider_locations/availability"},{"label":"Get insurance mappings for provider location","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/provider-locations/getproviderlocationinsurancemappings","routeSlug":"/apis/provider-locations/getproviderlocationinsurancemappings","metadata":{"seo":{"title":"Get insurance mappings for provider location","description":"Get eligible insurance plans and insurance mappings for a provider location by provider_location_id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProviderLocationInsuranceMappings","name":"Get insurance mappings for provider location","isWebhook":false,"pointer":"/paths/~1v1~1provider_locations~1{provider_location_id}~1insurance_mappings/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get insurance mappings for provider location","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get eligible insurance plans and insurance mappings for a provider location by provider_location_id"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsFlow","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Machine to machine authentication (for use from client server to Zocdoc)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com/oauth/token"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com/oauth/token"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}]},{"schemes":[{"name":"AuthorizationCodeFlow","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Log in as a user. Client Secret is not necessary for this login flow."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com"},"children":[]}]}]}],"flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"provider_location_id","in":"path","schemaId":"schema_40","description":"The Zocdoc provider location id to get insurance plans for.","required":true}],"pointer":"/paths/~1v1~1provider_locations~1{provider_location_id}~1insurance_mappings/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/provider_locations/{provider_location_id}/insurance_mappings","servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"parameters":{"path":[{"name":"provider_location_id","in":"path","required":true,"schemaId":"schema_40"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsFlow","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}],"scopes":[]},{"schemes":[{"id":"AuthorizationCodeFlow","type":"oauth2","flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404","409","500"],"pointer":"/v1/provider_locations/{provider_location_id}/insurance_mappings","href":"provider-locations/getproviderlocationinsurancemappings","openApiOperationId":"getProviderLocationInsuranceMappings","summary":"Get insurance mappings for provider location","securityGroups":[{"ClientCredentialsFlow":[]},{"AuthorizationCodeFlow":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetInsuranceMappingsResults"}},"schemaId":"components/schemas/GetInsuranceMappingsResults"},{"code":"400","description":"Invalid request parameters.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}},"schemaId":"components/schemas/ErrorResult"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}},"schemaId":"components/schemas/ErrorResult"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}},"schemaId":"components/schemas/ErrorResult"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1v1~1provider_locations~1{provider_location_id}~1insurance_mappings/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/GetInsuranceMappingsResults","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/GetInsuranceMappingsResults"}}},{"code":"400","schemaId":"components/schemas/ErrorResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/ErrorResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}}},{"code":"409","schemaId":"components/schemas/ErrorResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/provider-locations/getproviderlocationinsurancemappings"}],"panels":[]}]},"httpPath":"/v1/provider_locations/{provider_location_id}/insurance_mappings"},{"label":"Submit request to update mapped insurance plans","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/provider-locations/updateproviderlocationinsurancemappings","routeSlug":"/apis/provider-locations/updateproviderlocationinsurancemappings","metadata":{"seo":{"title":"Submit request to update mapped insurance plans","description":"Submits a request to update mapped insurance plans. This is an asynchronous operation and the response indicates the request was accepted for processing, not that the update is complete."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateProviderLocationInsuranceMappings","name":"Submit request to update mapped insurance plans","isWebhook":false,"pointer":"/paths/~1v1~1provider_locations~1{provider_location_id}~1insurance_mappings/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submit request to update mapped insurance plans","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Submits a request to update mapped insurance plans. This is an asynchronous operation and the response indicates the request was accepted for processing, not that the update is complete."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsFlow","scopes":["external.provider_insurance.write"],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Machine to machine authentication (for use from client server to Zocdoc)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com/oauth/token"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com/oauth/token"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"provider_location_id","in":"path","schemaId":"schema_40","description":"The Zocdoc provider location id to get insurance plans for.","required":true}],"pointer":"/paths/~1v1~1provider_locations~1{provider_location_id}~1insurance_mappings/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateInsuranceMappingsRequest"}},"schemaId":"components/schemas/UpdateInsuranceMappingsRequest","pointer":"/paths/~1v1~1provider_locations~1{provider_location_id}~1insurance_mappings/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/provider_locations/{provider_location_id}/insurance_mappings","servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"parameters":{"path":[{"name":"provider_location_id","in":"path","required":true,"schemaId":"schema_40"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsFlow","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}],"scopes":["external.provider_insurance.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateInsuranceMappingsRequest"}},"responseCodes":["202","400","401","403","404","409","500"],"pointer":"/v1/provider_locations/{provider_location_id}/insurance_mappings","href":"provider-locations/updateproviderlocationinsurancemappings","openApiOperationId":"updateProviderLocationInsuranceMappings","summary":"Submit request to update mapped insurance plans"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"schemaId":"components/schemas/UpdateInsuranceMappingsRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateInsuranceMappingsRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateInsuranceMappingsResult"}},"schemaId":"components/schemas/UpdateInsuranceMappingsResult"},{"code":"400","description":"Invalid request parameters.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}},"schemaId":"components/schemas/ErrorResult"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}},"schemaId":"components/schemas/ErrorResult"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}},"schemaId":"components/schemas/ErrorResult"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1v1~1provider_locations~1{provider_location_id}~1insurance_mappings/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/UpdateInsuranceMappingsResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UpdateInsuranceMappingsResult"}}},{"code":"400","schemaId":"components/schemas/ErrorResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/ErrorResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}}},{"code":"409","schemaId":"components/schemas/ErrorResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/provider-locations/updateproviderlocationinsurancemappings"}],"panels":[]}]},"httpPath":"/v1/provider_locations/{provider_location_id}/insurance_mappings"}],"content":{"contentType":"group","meta":{"name":"provider-locations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Provider locations","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints for retrieving and modifying provider location objects and their related insurance plans and availability."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/provider_locations","summary":"Get provider locations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/provider-locations/getproviderlocations","deprecated":false},{"title":"/v1/provider_locations/{provider_location_id}","summary":"Get provider location by id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/provider-locations/getproviderlocation","deprecated":false},{"title":"/v1/provider_locations/availability","summary":"Get availability for provider locations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/provider-locations/getproviderlocationsavailability","deprecated":false},{"title":"/v1/provider_locations/{provider_location_id}/insurance_mappings","summary":"Get insurance mappings for provider location","prefix":{"name":"get","color":"get"},"badges":[],"link":"/provider-locations/getproviderlocationinsurancemappings","deprecated":false},{"title":"/v1/provider_locations/{provider_location_id}/insurance_mappings","summary":"Submit request to update mapped insurance plans","prefix":{"name":"post","color":"post"},"badges":[],"link":"/provider-locations/updateproviderlocationinsurancemappings","deprecated":false}]}]}]}]}},{"type":"group","label":"Reviews","link":"/apis/reviews","routeSlug":"/apis/reviews","items":[{"label":"Get reviews for a single provider","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/reviews/getproviderreviews","routeSlug":"/apis/reviews/getproviderreviews","metadata":{"seo":{"title":"Get reviews for a single provider","description":"Get review summary for a provider by their Zocdoc provider ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProviderReviews","name":"Get reviews for a single provider","isWebhook":false,"pointer":"/paths/~1v1~1providers~1{provider_id}~1reviews/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get reviews for a single provider","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get review summary for a provider by their Zocdoc provider ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsFlow","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Machine to machine authentication (for use from client server to Zocdoc)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com/oauth/token"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com/oauth/token"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}]},{"schemes":[{"name":"AuthorizationCodeFlow","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Log in as a user. Client Secret is not necessary for this login flow."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com"},"children":[]}]}]}],"flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"provider_id","in":"path","schemaId":"schema_40","description":"The Zocdoc provider ID.","required":true}],"pointer":"/paths/~1v1~1providers~1{provider_id}~1reviews/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/providers/{provider_id}/reviews","servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"parameters":{"path":[{"name":"provider_id","in":"path","required":true,"schemaId":"schema_40"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsFlow","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}],"scopes":[]},{"schemes":[{"id":"AuthorizationCodeFlow","type":"oauth2","flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/v1/providers/{provider_id}/reviews","href":"reviews/getproviderreviews","openApiOperationId":"getProviderReviews","summary":"Get reviews for a single provider","securityGroups":[{"ClientCredentialsFlow":[]},{"AuthorizationCodeFlow":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProviderReviewsResponse"}},"schemaId":"components/schemas/ProviderReviewsResponse"},{"code":"400","description":"Invalid request parameters.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}},"schemaId":"components/schemas/ErrorResult"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Provider not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}},"schemaId":"components/schemas/ErrorResult"}],"pointer":"/paths/~1v1~1providers~1{provider_id}~1reviews/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProviderReviewsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProviderReviewsResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/ErrorResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reviews/getproviderreviews"}],"panels":[]}]},"httpPath":"/v1/providers/{provider_id}/reviews"},{"label":"Get reviews for providers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/reviews/getproviderreviewsbatch","routeSlug":"/apis/reviews/getproviderreviewsbatch","metadata":{"seo":{"title":"Get reviews for providers","description":"Get review summaries for up to 100 providers in a single call, by their Zocdoc provider IDs. Duplicate IDs are collapsed; returns one item per distinct requested ID, in request order. Providers that are unknown or not accessible to the caller are returned with zero/null ratings."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProviderReviewsBatch","name":"Get reviews for providers","isWebhook":false,"pointer":"/paths/~1v1~1providers~1reviews/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get reviews for providers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get review summaries for up to 100 providers in a single call, by their\nZocdoc provider IDs. Duplicate IDs are collapsed; returns one item per\ndistinct requested ID, in request order. Providers that are unknown or\nnot accessible to the caller are returned with zero/null ratings.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsFlow","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Machine to machine authentication (for use from client server to Zocdoc)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com/oauth/token"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com/oauth/token"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}]},{"schemes":[{"name":"AuthorizationCodeFlow","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Log in as a user. Client Secret is not necessary for this login flow."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com"},"children":[]}]}]}],"flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"provider_ids","in":"query","schemaId":"schema_63","description":"A comma-delimited list of Zocdoc provider IDs to fetch review summaries for. Duplicate IDs are collapsed; a maximum of 100 distinct items will be accepted at a time. IDs that are unknown or not accessible to the caller are returned with zero reviews and null ratings (not an error).","required":true}],"pointer":"/paths/~1v1~1providers~1reviews/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/providers/reviews","servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"parameters":{"path":[],"query":[{"name":"provider_ids","in":"query","required":true,"example":"pr_xyz123,pr_abc456","schemaId":"schema_63"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsFlow","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}],"scopes":[]},{"schemes":[{"id":"AuthorizationCodeFlow","type":"oauth2","flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}],"scopes":[]}],"responseCodes":["200","400","401","403"],"pointer":"/v1/providers/reviews","href":"reviews/getproviderreviewsbatch","openApiOperationId":"getProviderReviewsBatch","summary":"Get reviews for providers","securityGroups":[{"ClientCredentialsFlow":[]},{"AuthorizationCodeFlow":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProviderReviewsBatchResponse"}},"schemaId":"components/schemas/ProviderReviewsBatchResponse"},{"code":"400","description":"Invalid request parameters.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}},"schemaId":"components/schemas/ErrorResult"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"}],"pointer":"/paths/~1v1~1providers~1reviews/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ProviderReviewsBatchResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProviderReviewsBatchResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}}},{"code":"401"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/reviews/getproviderreviewsbatch"}],"panels":[]}]},"httpPath":"/v1/providers/reviews"}],"content":{"contentType":"group","meta":{"name":"reviews"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reviews","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints to retrieve provider reviews and ratings."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/providers/{provider_id}/reviews","summary":"Get reviews for a single provider","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reviews/getproviderreviews","deprecated":false},{"title":"/v1/providers/reviews","summary":"Get reviews for providers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reviews/getproviderreviewsbatch","deprecated":false}]}]}]}]}},{"type":"group","label":"Facilities","link":"/apis/facilities","routeSlug":"/apis/facilities","items":[{"label":"Get facilities","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/facilities/getfacilities","routeSlug":"/apis/facilities/getfacilities","metadata":{"seo":{"title":"Get facilities","description":"Get a set of facilities within the developer's network."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFacilities","name":"Get facilities","isWebhook":false,"pointer":"/paths/~1v1-beta~1facilities/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get facilities","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a set of facilities within the developer's network."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsFlow","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Machine to machine authentication (for use from client server to Zocdoc)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com/oauth/token"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com/oauth/token"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}]},{"schemes":[{"name":"AuthorizationCodeFlow","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Log in as a user. Client Secret is not necessary for this login flow."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com"},"children":[]}]}]}],"flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"npis","in":"query","schemaId":"schema_50","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A comma-delimited list of Provider NPI numbers. A maximum of 50 items will be accepted at a time. One of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"zip_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"npis"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required."},"children":[]}]}]}]},{"name":"zip_code","in":"query","schemaId":"schema_53","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A 5 digit zip code that will be used as the location to find facilities near by. One of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"zip_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"npis"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required."},"children":[]}]}]}]},{"name":"building_type","in":"query","schemaId":"schema_64","description":"The type of facility building, which can be Clinic or Hospital."},{"name":"page","in":"query","schemaId":"schema_38","description":"The zero indexed page of results."},{"name":"page_size","in":"query","schemaId":"schema_38","description":"The number of results to return per page."},{"name":"visit_reason_id","in":"query","schemaId":"schema_55","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Zocdoc ID of the visit reason to search by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"zip_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/reference-data"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reference Data"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for options."},"children":[]}]}]}]},{"name":"insurance_plan_id","in":"query","schemaId":"schema_49","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Zocdoc ID of the patient's insurance plan to search by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"zip_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for. Use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/getInsurancePlans"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get Insurance Plans"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint to retrieve available plans."},"children":[]}]}]}]},{"name":"max_distance_to_patient_mi","in":"query","schemaId":"schema_38","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The maximum distance in miles from the facility to the search location (the center point of the given "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"zip_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Default is 50 miles."},"children":[]}]}]}]}],"pointer":"/paths/~1v1-beta~1facilities/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1-beta/facilities","servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"parameters":{"path":[],"query":[{"name":"npis","in":"query","example":"1234567891,0123456789","schemaId":"schema_50"},{"name":"zip_code","in":"query","example":36925,"schemaId":"schema_53"},{"name":"building_type","in":"query","schemaId":"components/schemas/BuildingType"},{"name":"page","in":"query","schemaId":"schema_38"},{"name":"page_size","in":"query","schemaId":"schema_38"},{"name":"visit_reason_id","in":"query","example":"pc_FRO-18leckytNKtruw5dLR","schemaId":"schema_55"},{"name":"insurance_plan_id","in":"query","example":"ip_31820","schemaId":"schema_49"},{"name":"max_distance_to_patient_mi","in":"query","required":false,"schemaId":"schema_38"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsFlow","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}],"scopes":[]},{"schemes":[{"id":"AuthorizationCodeFlow","type":"oauth2","flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/v1-beta/facilities","href":"facilities/getfacilities","openApiOperationId":"getFacilities","summary":"Get facilities","securityGroups":[{"ClientCredentialsFlow":[]},{"AuthorizationCodeFlow":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FacilitiesResponse"}},"schemaId":"components/schemas/FacilitiesResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}},"schemaId":"components/schemas/ErrorResult"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not found"}],"pointer":"/paths/~1v1-beta~1facilities/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FacilitiesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FacilitiesResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}}},{"code":"401"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/facilities/getfacilities"}],"panels":[]}]},"httpPath":"/v1-beta/facilities"},{"label":"Get facility by id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/facilities/getfacility","routeSlug":"/apis/facilities/getfacility","metadata":{"seo":{"title":"Get facility by id","description":"Get facility by facility id."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFacility","name":"Get facility by id","isWebhook":false,"pointer":"/paths/~1v1-beta~1facilities~1{facility_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get facility by id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get facility by facility id."},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsFlow","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Machine to machine authentication (for use from client server to Zocdoc)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com/oauth/token"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com/oauth/token"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}]},{"schemes":[{"name":"AuthorizationCodeFlow","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Log in as a user. Client Secret is not necessary for this login flow."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com"},"children":[]}]}]}],"flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"facility_id","in":"path","schemaId":"schema_65","description":"Zocdoc facility id.","required":true}],"pointer":"/paths/~1v1-beta~1facilities~1{facility_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1-beta/facilities/{facility_id}","servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"parameters":{"path":[{"name":"facility_id","in":"path","required":true,"example":"d04b049a-41b1-4aba-9268-d8973cf72cdd","schemaId":"schema_65"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsFlow","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}],"scopes":[]},{"schemes":[{"id":"AuthorizationCodeFlow","type":"oauth2","flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/v1-beta/facilities/{facility_id}","href":"facilities/getfacility","openApiOperationId":"getFacility","summary":"Get facility by id","securityGroups":[{"ClientCredentialsFlow":[]},{"AuthorizationCodeFlow":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FacilityByIdResponse"}},"schemaId":"components/schemas/FacilityByIdResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}},"schemaId":"components/schemas/ErrorResult"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not found"}],"pointer":"/paths/~1v1-beta~1facilities~1{facility_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/FacilityByIdResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FacilityByIdResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}}},{"code":"401"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/facilities/getfacility"}],"panels":[]}]},"httpPath":"/v1-beta/facilities/{facility_id}"}],"content":{"contentType":"group","meta":{"name":"facilities"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Facilities","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints to retrieve facilities within the developer's directory."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1-beta/facilities","summary":"Get facilities","prefix":{"name":"get","color":"get"},"badges":[],"link":"/facilities/getfacilities","deprecated":false},{"title":"/v1-beta/facilities/{facility_id}","summary":"Get facility by id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/facilities/getfacility","deprecated":false}]}]}]}]}},{"type":"group","label":"Calendar integration timeslots","link":"/apis/calendar-integration-timeslots","routeSlug":"/apis/calendar-integration-timeslots","items":[{"label":"Get timeslots for provider on date","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/calendar-integration-timeslots/getprovidercalendartimeslots","routeSlug":"/apis/calendar-integration-timeslots/getprovidercalendartimeslots","metadata":{"seo":{"title":"Get timeslots for provider on date","description":"Get timeslots for a provider and date."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getProviderCalendarTimeslots","name":"Get timeslots for provider on date","isWebhook":false,"pointer":"/paths/~1v1~1providers~1{provider_id}~1calendar~1timeslots/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get timeslots for provider on date","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get timeslots for a provider and date."},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"provider_id","in":"path","schemaId":"schema_66","required":true}],"pointer":"/paths/~1v1~1providers~1{provider_id}~1calendar~1timeslots/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"date","in":"query","schemaId":"schema_67","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date for which to get timeslots in YYYY-MM-DD format. This parameter will match against the local date part of the time slot's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For example, a timeslot with start_time of 2024-10-01T22:00 and time_zone of America/New_York is considered 2024-10-01 when querying timeslots, even though it resolves to 2024-10-02 in UTC."},"children":[]}]}]}],"required":true},{"name":"next_page_token","in":"query","schemaId":"schema_40","description":"A token to get the next set of results."},{"name":"limit","in":"query","schemaId":"schema_38","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The limit of objects to get in the response. For this endpoint, this is equivalent to page_size."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1providers~1{provider_id}~1calendar~1timeslots/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/providers/{provider_id}/calendar/timeslots","servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"parameters":{"path":[{"name":"provider_id","in":"path","required":true,"example":"pr_abc123-def456_wxyz7890","schemaId":"schema_66"}],"query":[{"name":"date","in":"query","required":true,"example":"2024-10-26","schemaId":"schema_67"},{"name":"next_page_token","in":"query","required":false,"schemaId":"schema_40"},{"name":"limit","in":"query","required":false,"schemaId":"schema_38"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403"],"pointer":"/v1/providers/{provider_id}/calendar/timeslots","href":"calendar-integration-timeslots/getprovidercalendartimeslots","openApiOperationId":"getProviderCalendarTimeslots","summary":"Get timeslots for provider on date"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TimeslotListResponse"}},"schemaId":"components/schemas/TimeslotListResponse"},{"code":"400","description":"Invalid request parameters."},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"}],"pointer":"/paths/~1v1~1providers~1{provider_id}~1calendar~1timeslots/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TimeslotListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TimeslotListResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/calendar-integration-timeslots/getprovidercalendartimeslots"}],"panels":[]}]},"httpPath":"/v1/providers/{provider_id}/calendar/timeslots"},{"label":"Put provider calendar timeslots","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/calendar-integration-timeslots/putprovidercalendartimeslots","routeSlug":"/apis/calendar-integration-timeslots/putprovidercalendartimeslots","metadata":{"seo":{"title":"Put provider calendar timeslots","description":"This endpoint sets the complete list of available slots for a specific provider on a specific date. Each request must include the entire set of slots for that date. If a provider wishes to list times at multiple locations for a single date, each location must have its own timeslot object added to the array. A new request made for the same provider and date will overwrite the previous set of slots. If you send an empty array, all slots for that provider across all locations on that date will be deleted."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"putProviderCalendarTimeslots","name":"Put provider calendar timeslots","isWebhook":false,"pointer":"/paths/~1v1~1providers~1{provider_id}~1calendar~1timeslots/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Put provider calendar timeslots","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint sets the complete list of available slots for a specific provider on a specific date. Each request must include the entire set of slots for that date. If a provider wishes to list times at multiple locations for a single date, each location must have its own timeslot object added to the array. A new request made for the same provider and date will overwrite the previous set of slots. If you send an empty array, all slots for that provider across all locations on that date will be deleted."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The timeslots are stored in an eventually consistent data store. This means there is a small"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"possibility that a fetch might not include recently created slots if you fetch timeslots immediately after inserting them."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parameter Validations"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user must have access to the specified "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"provider_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validations for each timeslot in the request body"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"slot.provider_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must match the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"provider_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" specified in the endpoint parameter."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"slot.start_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be a valid \"local date-time\" string in ISO 8601 format, e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2024-09-15T12:13:00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The seconds component is optional."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date component must match the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"date"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"slot.time_zone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be a valid IANA time zone ID (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"America/New_York"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"America/Denver"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"provider_id","in":"path","schemaId":"schema_66","required":true}],"pointer":"/paths/~1v1~1providers~1{provider_id}~1calendar~1timeslots/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"date","in":"query","schemaId":"schema_68","description":"The date for which to put timeslots in YYYY-MM-DD format.","required":true}],"pointer":"/paths/~1v1~1providers~1{provider_id}~1calendar~1timeslots/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TimeslotPutRequest"}},"schemaId":"components/schemas/TimeslotPutRequest","pointer":"/paths/~1v1~1providers~1{provider_id}~1calendar~1timeslots/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/providers/{provider_id}/calendar/timeslots","servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"parameters":{"path":[{"name":"provider_id","in":"path","required":true,"example":"pr_abc123-def456_wxyz7890","schemaId":"schema_66"}],"query":[{"name":"date","in":"query","required":true,"example":"2024-10-16","schemaId":"schema_68"}],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/TimeslotPutRequest"}},"responseCodes":["200","400","401","403"],"pointer":"/v1/providers/{provider_id}/calendar/timeslots","href":"calendar-integration-timeslots/putprovidercalendartimeslots","openApiOperationId":"putProviderCalendarTimeslots","summary":"Put provider calendar timeslots"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"schemaId":"components/schemas/TimeslotPutRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TimeslotPutRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TimeslotPutResponse"}},"schemaId":"components/schemas/TimeslotPutResponse"},{"code":"400","description":"Invalid request parameters."},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"}],"pointer":"/paths/~1v1~1providers~1{provider_id}~1calendar~1timeslots/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/TimeslotPutResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/TimeslotPutResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/calendar-integration-timeslots/putprovidercalendartimeslots"}],"panels":[]}]},"httpPath":"/v1/providers/{provider_id}/calendar/timeslots"}],"content":{"contentType":"group","meta":{"name":"calendar-integration-timeslots"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Calendar integration timeslots","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints to manage timeslots for providers."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/providers/{provider_id}/calendar/timeslots","summary":"Get timeslots for provider on date","prefix":{"name":"get","color":"get"},"badges":[],"link":"/calendar-integration-timeslots/getprovidercalendartimeslots","deprecated":false},{"title":"/v1/providers/{provider_id}/calendar/timeslots","summary":"Put provider calendar timeslots","prefix":{"name":"put","color":"put"},"badges":[],"link":"/calendar-integration-timeslots/putprovidercalendartimeslots","deprecated":false}]}]}]}]}},{"type":"group","label":"Appointments","link":"/apis/appointments","routeSlug":"/apis/appointments","items":[{"label":"Create appointment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/appointments/createappointment","routeSlug":"/apis/appointments/createappointment","metadata":{"seo":{"title":"Create appointment","description":"This endpoint is used for creating new appointments. Developers should gather the necessary information to pass in the request body as inputs for this endpoint. Only timeslots retrieved from the /v1/provider_locations/availability endpoint will be accepted. After an /appointments call is successfully processed, the system will return an appointment ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createAppointment","name":"Create appointment","isWebhook":false,"pointer":"/paths/~1v1~1appointments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create appointment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is used for creating new appointments. Developers should gather the necessary information to pass in the request body as inputs for this endpoint. Only timeslots retrieved from the /v1/provider_locations/availability endpoint will be accepted. After an /appointments call is successfully processed, the system will return an appointment ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"appointment_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returned is used in the endpoint /v1/appointments/{appointment_id} to track the status of the appointment, and in the endpoint /v1/appointments/cancel to cancel an appointment."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsFlow","scopes":["external.appointment.write"],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Machine to machine authentication (for use from client server to Zocdoc)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com/oauth/token"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com/oauth/token"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}]},{"schemes":[{"name":"AuthorizationCodeFlow","scopes":["external.appointment.write"],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Log in as a user. Client Secret is not necessary for this login flow."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com"},"children":[]}]}]}],"flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BookAppointmentRequestBody"}},"schemaId":"components/schemas/BookAppointmentRequestBody","pointer":"/paths/~1v1~1appointments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/appointments","servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsFlow","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}],"scopes":["external.appointment.write"]},{"schemes":[{"id":"AuthorizationCodeFlow","type":"oauth2","flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}],"scopes":["external.appointment.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BookAppointmentRequestBody"}},"responseCodes":["200","400","401","403","409"],"pointer":"/v1/appointments","href":"appointments/createappointment","openApiOperationId":"createAppointment","summary":"Create appointment","securityGroups":[{"ClientCredentialsFlow":["external.appointment.write"]},{"AuthorizationCodeFlow":["external.appointment.write"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"schemaId":"components/schemas/BookAppointmentRequestBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BookAppointmentRequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentResponse"}},"schemaId":"components/schemas/AppointmentResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}},"schemaId":"components/schemas/ErrorResult"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}},"schemaId":"components/schemas/ErrorResult"}],"pointer":"/paths/~1v1~1appointments/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppointmentResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}}},{"code":"401"},{"code":"403"},{"code":"409","schemaId":"components/schemas/ErrorResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/createappointment"}],"panels":[]}]},"httpPath":"/v1/appointments"},{"label":"Get appointments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/appointments/getappointments","routeSlug":"/apis/appointments/getappointments","metadata":{"seo":{"title":"Get appointments","description":"This endpoint retrieves the paginated list of appointment details and statuses for the given credential. By default, appointments will be returned in descending order of start time."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAppointments","name":"Get appointments","isWebhook":false,"pointer":"/paths/~1v1~1appointments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get appointments","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint retrieves the paginated list of appointment details and statuses for the given credential. By default, appointments will be returned in descending order of start time.\n\nA maximum of 1,000 total appointments will be returned via pagination; if more are expected, use filters and batch requests.\n\nIf the request comes from a Zocdoc user credential, only appointments that user has created will be returned. If the request comes from a machine-to-machine credential, any appointments that were booked with that developer will be returned.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsFlow","scopes":["external.appointment.read"],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Machine to machine authentication (for use from client server to Zocdoc)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com/oauth/token"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com/oauth/token"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}]},{"schemes":[{"name":"AuthorizationCodeFlow","scopes":["external.appointment.read"],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Log in as a user. Client Secret is not necessary for this login flow."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com"},"children":[]}]}]}],"flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_38","description":"The zero indexed page of results. A mimimum value of 0 and a maximum of 10 will be accepted."},{"name":"page_size","in":"query","schemaId":"schema_38","description":"The number of results to return per page. A mimimum value of 1 and a maximum of 100 will be accepted."},{"name":"statuses","in":"query","schemaId":"schema_69","description":"A comma-delimited list of Zocodc appointment statuses to filter appointments by."},{"name":"developer_patient_id","in":"query","schemaId":"schema_40","description":"The patient identifier provided by 3P developer to filter appointments by."},{"name":"sort_by","in":"query","schemaId":"schema_70","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field to sort appointments by. Default is start_time."},"children":[]}]}]}]},{"name":"sort_direction","in":"query","schemaId":"schema_71","description":"The direction to sort appointments by. Default is descending."},{"name":"practice_ids","in":"query","schemaId":"schema_72","description":"The comma separated values of practice ids to filter appointments by"},{"name":"provider_ids","in":"query","schemaId":"schema_73","description":"The comma separated values of provider ids to filter appointments by"},{"name":"location_ids","in":"query","schemaId":"schema_74","description":"The comma separated values of location ids to filter appointments by"},{"name":"start_time_utc_min","in":"query","schemaId":"schema_75","description":"The minimum UTC start time of the appointments to fetch. Exclude appointments that start before this time."},{"name":"start_time_utc_max","in":"query","schemaId":"schema_75","description":"The maximum UTC start time of the appointments to fetch. Exclude appointments that start after this time."},{"name":"created_time_utc_min","in":"query","schemaId":"schema_75","description":"The minimum UTC created time of the appointments to fetch. Exclude appointments that were created before this time."},{"name":"created_time_utc_max","in":"query","schemaId":"schema_75","description":"The maximum UTC created time of the appointments to fetch. Exclude appointments that were created after this time."},{"name":"last_modified_time_utc_min","in":"query","schemaId":"schema_75","description":"The minimum UTC last modified time of the appointments to fetch. Exclude appointments that were last modified before this time."},{"name":"last_modified_time_utc_max","in":"query","schemaId":"schema_75","description":"The maximum UTC last modified time of the appointments to fetch. Exclude appointments that were last modified after this time."}],"pointer":"/paths/~1v1~1appointments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/appointments","servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","required":false,"schemaId":"schema_38"},{"name":"page_size","in":"query","required":false,"schemaId":"schema_38"},{"name":"statuses","in":"query","required":false,"example":"pending_booking,confirmed","schemaId":"schema_69"},{"name":"developer_patient_id","in":"query","required":false,"schemaId":"schema_40"},{"name":"sort_by","in":"query","required":false,"schemaId":"components/schemas/AppointmentSortByType"},{"name":"sort_direction","in":"query","required":false,"schemaId":"components/schemas/AppointmentSortDirectionType"},{"name":"practice_ids","in":"query","required":false,"example":"pt_abc123-def456_wxyz7890,pt_ghi123-jkl456_mnop7890","schemaId":"schema_72"},{"name":"provider_ids","in":"query","required":false,"example":"pr_abc123-def456_wxyz7890,pr_ghi123-jkl456_mnop7890","schemaId":"schema_73"},{"name":"location_ids","in":"query","required":false,"example":"lo_abc123-def456_wxyz7890,lo_ghi123-jkl456_mnop7890","schemaId":"schema_74"},{"name":"start_time_utc_min","in":"query","required":false,"example":"2024-01-01 00:00:00+00:00","schemaId":"schema_75"},{"name":"start_time_utc_max","in":"query","required":false,"example":"2024-01-01 00:00:00+00:00","schemaId":"schema_75"},{"name":"created_time_utc_min","in":"query","required":false,"example":"2024-01-01 00:00:00+00:00","schemaId":"schema_75"},{"name":"created_time_utc_max","in":"query","required":false,"example":"2024-01-01 00:00:00+00:00","schemaId":"schema_75"},{"name":"last_modified_time_utc_min","in":"query","required":false,"example":"2024-01-01 00:00:00+00:00","schemaId":"schema_75"},{"name":"last_modified_time_utc_max","in":"query","required":false,"example":"2024-01-01 00:00:00+00:00","schemaId":"schema_75"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsFlow","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}],"scopes":["external.appointment.read"]},{"schemes":[{"id":"AuthorizationCodeFlow","type":"oauth2","flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}],"scopes":["external.appointment.read"]}],"responseCodes":["200","400","401","403"],"pointer":"/v1/appointments","href":"appointments/getappointments","openApiOperationId":"getAppointments","summary":"Get appointments","securityGroups":[{"ClientCredentialsFlow":["external.appointment.read"]},{"AuthorizationCodeFlow":["external.appointment.read"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentStatusListResponse"}},"schemaId":"components/schemas/AppointmentStatusListResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}},"schemaId":"components/schemas/ErrorResult"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"}],"pointer":"/paths/~1v1~1appointments/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppointmentStatusListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentStatusListResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}}},{"code":"401"},{"code":"403"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/getappointments"}],"panels":[]}]},"httpPath":"/v1/appointments"},{"label":"Get appointment by id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/appointments/getappointment","routeSlug":"/apis/appointments/getappointment","metadata":{"seo":{"title":"Get appointment by id","description":"This endpoint retrieves updated appointment details and the status of a single existing appointment. Developers must send a valid appointment_id as input in the request body, and Zocdoc returns the appointment details and status for that appointment. See Appointment Status definitions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAppointment","name":"Get appointment by id","isWebhook":false,"pointer":"/paths/~1v1~1appointments~1{appointment_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get appointment by id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint retrieves updated appointment details and the status of a single existing appointment. Developers must send a valid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"appointment_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as input in the request body, and Zocdoc returns the appointment details and status for that appointment. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/glossary"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Appointment Status definitions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the appointment was booked with a Zocdoc user credential, only that user will have access to view or modify the appointment. If the appointment was booked with a machine-to-machine credential, the appointment can be viewed and modified by any of the developer's machine-to-machine credentials."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsFlow","scopes":["external.appointment.read"],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Machine to machine authentication (for use from client server to Zocdoc)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com/oauth/token"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com/oauth/token"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}]},{"schemes":[{"name":"AuthorizationCodeFlow","scopes":["external.appointment.read"],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Log in as a user. Client Secret is not necessary for this login flow."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com"},"children":[]}]}]}],"flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"appointment_id","in":"path","schemaId":"schema_65","description":"The Zocdoc ID for the appointment.","required":true}],"pointer":"/paths/~1v1~1appointments~1{appointment_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/appointments/{appointment_id}","servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"parameters":{"path":[{"name":"appointment_id","in":"path","required":true,"example":"d04b049a-41b1-4aba-9268-d8973cf72cdd","schemaId":"schema_65"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsFlow","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}],"scopes":["external.appointment.read"]},{"schemes":[{"id":"AuthorizationCodeFlow","type":"oauth2","flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}],"scopes":["external.appointment.read"]}],"responseCodes":["200","401","403","404"],"pointer":"/v1/appointments/{appointment_id}","href":"appointments/getappointment","openApiOperationId":"getAppointment","summary":"Get appointment by id","securityGroups":[{"ClientCredentialsFlow":["external.appointment.read"]},{"AuthorizationCodeFlow":["external.appointment.read"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentStatusResponse"}},"schemaId":"components/schemas/AppointmentStatusResponse"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}},"schemaId":"components/schemas/ErrorResult"}],"pointer":"/paths/~1v1~1appointments~1{appointment_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppointmentStatusResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentStatusResponse"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/ErrorResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/getappointment"}],"panels":[]}]},"httpPath":"/v1/appointments/{appointment_id}"},{"label":"Get participants for appointment","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/appointments/getappointmentparticipants","routeSlug":"/apis/appointments/getappointmentparticipants","metadata":{"seo":{"title":"Get participants for appointment","description":"This endpoint retrieves the participants of an appointment. Developers must provide a valid appointment_id as a path parameter, and Zocdoc returns the participants of that appointment."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAppointmentParticipants","name":"Get participants for appointment","isWebhook":false,"pointer":"/paths/~1v1~1appointments~1{appointment_id}~1participants/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get participants for appointment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint retrieves the participants of an appointment. Developers must provide a valid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"appointment_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as a path parameter, and Zocdoc returns the participants of that appointment."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsFlow","scopes":["external.appointment.read"],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Machine to machine authentication (for use from client server to Zocdoc)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com/oauth/token"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com/oauth/token"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}]},{"schemes":[{"name":"AuthorizationCodeFlow","scopes":["external.appointment.read"],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Log in as a user. Client Secret is not necessary for this login flow."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com"},"children":[]}]}]}],"flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"appointment_id","in":"path","schemaId":"schema_65","description":"The Zocdoc id of the appointment","required":true}],"pointer":"/paths/~1v1~1appointments~1{appointment_id}~1participants/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/appointments/{appointment_id}/participants","servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"parameters":{"path":[{"name":"appointment_id","in":"path","required":true,"example":"d04b049a-41b1-4aba-9268-d8973cf72cdd","schemaId":"schema_65"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsFlow","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}],"scopes":["external.appointment.read"]},{"schemes":[{"id":"AuthorizationCodeFlow","type":"oauth2","flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}],"scopes":["external.appointment.read"]}],"responseCodes":["200","401","403","404"],"pointer":"/v1/appointments/{appointment_id}/participants","href":"appointments/getappointmentparticipants","openApiOperationId":"getAppointmentParticipants","summary":"Get participants for appointment","securityGroups":[{"ClientCredentialsFlow":["external.appointment.read"]},{"AuthorizationCodeFlow":["external.appointment.read"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentParticipantsResponse"}},"schemaId":"components/schemas/AppointmentParticipantsResponse"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}},"schemaId":"components/schemas/ErrorResult"}],"pointer":"/paths/~1v1~1appointments~1{appointment_id}~1participants/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppointmentParticipantsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentParticipantsResponse"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/ErrorResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/getappointmentparticipants"}],"panels":[]}]},"httpPath":"/v1/appointments/{appointment_id}/participants"},{"label":"Cancel appointment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/appointments/cancelappointment","routeSlug":"/apis/appointments/cancelappointment","metadata":{"seo":{"title":"Cancel appointment","description":"This endpoint is used to request the cancellation of an appointment in a non-cancelled status. (Non-cancelled statuses include: pending_booking, booking_failed, confirmed, pending_reschedule, reschedule_failed and rescheduled)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancelAppointment","name":"Cancel appointment","isWebhook":false,"pointer":"/paths/~1v1~1appointments~1cancel/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel appointment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is used to request the cancellation of an appointment in a non-cancelled status. (Non-cancelled statuses include: pending_booking, booking_failed, confirmed, pending_reschedule, reschedule_failed and rescheduled)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Developers must send a valid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"appointment_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as input in the request body and may choose to pass a cancellation reason using the standardized "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancellation_reason_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field. The optional "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cancellation_reason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field should only be used when the cancellation reason type is 'other_patient_reason' or 'other_provider_reason' to provide additional context."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the appointment was booked with a Zocdoc user credential, only that user will have access to view or modify the appointment. If the appointment was booked with a machine-to-machine credential, the appointment can be viewed and modified by any of the developer's machine-to-machine credentials."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsFlow","scopes":["external.appointment.write"],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Machine to machine authentication (for use from client server to Zocdoc)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com/oauth/token"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com/oauth/token"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}]},{"schemes":[{"name":"AuthorizationCodeFlow","scopes":["external.appointment.write"],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Log in as a user. Client Secret is not necessary for this login flow."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com"},"children":[]}]}]}],"flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CancelAppointmentRequestBody"}},"schemaId":"components/schemas/CancelAppointmentRequestBody","pointer":"/paths/~1v1~1appointments~1cancel/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/appointments/cancel","servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsFlow","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}],"scopes":["external.appointment.write"]},{"schemes":[{"id":"AuthorizationCodeFlow","type":"oauth2","flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}],"scopes":["external.appointment.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CancelAppointmentRequestBody"}},"responseCodes":["200","400","401","403","404","409"],"pointer":"/v1/appointments/cancel","href":"appointments/cancelappointment","openApiOperationId":"cancelAppointment","summary":"Cancel appointment","securityGroups":[{"ClientCredentialsFlow":["external.appointment.write"]},{"AuthorizationCodeFlow":["external.appointment.write"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"schemaId":"components/schemas/CancelAppointmentRequestBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CancelAppointmentRequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentBaseResponse"}},"schemaId":"components/schemas/AppointmentBaseResponse"},{"code":"400","description":"Bad request"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}},"schemaId":"components/schemas/ErrorResult"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}},"schemaId":"components/schemas/ErrorResult"}],"pointer":"/paths/~1v1~1appointments~1cancel/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppointmentBaseResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentBaseResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/ErrorResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}}},{"code":"409","schemaId":"components/schemas/ErrorResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/cancelappointment"}],"panels":[]}]},"httpPath":"/v1/appointments/cancel"},{"label":"Confirm appointment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/appointments/confirmappointment","routeSlug":"/apis/appointments/confirmappointment","metadata":{"seo":{"title":"Confirm appointment","description":"This endpoint is used to confirm an appointment in pending booking status. Developers must send a valid appointment_id as input in the request body."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"confirmAppointment","name":"Confirm appointment","isWebhook":false,"pointer":"/paths/~1v1~1appointments~1confirm/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Confirm appointment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is used to confirm an appointment in pending booking status. Developers must send a valid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"appointment_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as input in the request body."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsFlow","scopes":["external.appointment.write"],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Machine to machine authentication (for use from client server to Zocdoc)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com/oauth/token"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com/oauth/token"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}]},{"schemes":[{"name":"AuthorizationCodeFlow","scopes":["external.appointment.write"],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Log in as a user. Client Secret is not necessary for this login flow."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com"},"children":[]}]}]}],"flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConfirmAppointmentRequestBody"}},"schemaId":"components/schemas/ConfirmAppointmentRequestBody","pointer":"/paths/~1v1~1appointments~1confirm/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/appointments/confirm","servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsFlow","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}],"scopes":["external.appointment.write"]},{"schemes":[{"id":"AuthorizationCodeFlow","type":"oauth2","flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}],"scopes":["external.appointment.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ConfirmAppointmentRequestBody"}},"responseCodes":["200","400","401","403","404","409"],"pointer":"/v1/appointments/confirm","href":"appointments/confirmappointment","openApiOperationId":"confirmAppointment","summary":"Confirm appointment","securityGroups":[{"ClientCredentialsFlow":["external.appointment.write"]},{"AuthorizationCodeFlow":["external.appointment.write"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"schemaId":"components/schemas/ConfirmAppointmentRequestBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConfirmAppointmentRequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentBaseResponse"}},"schemaId":"components/schemas/AppointmentBaseResponse"},{"code":"400","description":"Bad request.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}},"schemaId":"components/schemas/ErrorResult"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}},"schemaId":"components/schemas/ErrorResult"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}},"schemaId":"components/schemas/ErrorResult"}],"pointer":"/paths/~1v1~1appointments~1confirm/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppointmentBaseResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentBaseResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/ErrorResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}}},{"code":"409","schemaId":"components/schemas/ErrorResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/confirmappointment"}],"panels":[]}]},"httpPath":"/v1/appointments/confirm"},{"label":"Reschedule appointment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/appointments/rescheduleappointment","routeSlug":"/apis/appointments/rescheduleappointment","metadata":{"seo":{"title":"Reschedule appointment","description":"This endpoint is used to only modify the appointment time and request the reschedule of an appointment in pending_booking, confirmed, pending_reschedule, or rescheduled status. Developers must send a valid appointment_id and a new start time as input in the request body."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"rescheduleAppointment","name":"Reschedule appointment","isWebhook":false,"pointer":"/paths/~1v1~1appointments~1reschedule/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reschedule appointment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is used to only modify the appointment time and request the reschedule of an appointment in pending_booking, confirmed, pending_reschedule, or rescheduled status. Developers must send a valid "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"appointment_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and a new start time as input in the request body."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the appointment was booked with a Zocdoc user credential, only that user will have access to view or modify the appointment. If the appointment was booked with a machine-to-machine credential, the appointment can be viewed and modified by any of the developer's machine-to-machine credentials."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsFlow","scopes":["external.appointment.write"],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Machine to machine authentication (for use from client server to Zocdoc)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com/oauth/token"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com/oauth/token"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}]},{"schemes":[{"name":"AuthorizationCodeFlow","scopes":["external.appointment.write"],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Log in as a user. Client Secret is not necessary for this login flow."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com"},"children":[]}]}]}],"flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RescheduleAppointmentRequestBody"}},"schemaId":"components/schemas/RescheduleAppointmentRequestBody","pointer":"/paths/~1v1~1appointments~1reschedule/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/appointments/reschedule","servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsFlow","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}],"scopes":["external.appointment.write"]},{"schemes":[{"id":"AuthorizationCodeFlow","type":"oauth2","flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}],"scopes":["external.appointment.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/RescheduleAppointmentRequestBody"}},"responseCodes":["200","400","401","403","404"],"pointer":"/v1/appointments/reschedule","href":"appointments/rescheduleappointment","openApiOperationId":"rescheduleAppointment","summary":"Reschedule appointment","securityGroups":[{"ClientCredentialsFlow":["external.appointment.write"]},{"AuthorizationCodeFlow":["external.appointment.write"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"schemaId":"components/schemas/RescheduleAppointmentRequestBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/RescheduleAppointmentRequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentResponse"}},"schemaId":"components/schemas/AppointmentResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}},"schemaId":"components/schemas/ErrorResult"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}},"schemaId":"components/schemas/ErrorResult"}],"pointer":"/paths/~1v1~1appointments~1reschedule/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppointmentResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/ErrorResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/rescheduleappointment"}],"panels":[]}]},"httpPath":"/v1/appointments/reschedule"},{"label":"Create attachment for appointment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/appointments/uploadappointmentattachment","routeSlug":"/apis/appointments/uploadappointmentattachment","metadata":{"seo":{"title":"Create attachment for appointment","description":"This endpoint is used to upload attachment documents related to the appointment for the provider to view. You can upload more than one attachment with the same attachment_type for the same appointment_id if needed. The provider will be able to receive all uploaded attachments."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"uploadAppointmentAttachment","name":"Create attachment for appointment","isWebhook":false,"pointer":"/paths/~1v1~1appointments~1{appointment_id}~1attachments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create attachment for appointment","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint is used to upload attachment documents related to the appointment for the provider to view. You can upload more than one attachment with the same attachment_type for the same appointment_id if needed. The provider will be able to receive all uploaded attachments."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only documents of type jpg, png, pdf, and docx are supported. Documents must be less than 100MB. You may not upload attachments to appointments in a failed state or over 7 days after the appointment."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsFlow","scopes":["external.appointment.write"],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Machine to machine authentication (for use from client server to Zocdoc)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com/oauth/token"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com/oauth/token"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}]},{"schemes":[{"name":"AuthorizationCodeFlow","scopes":["external.appointment.write"],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Log in as a user. Client Secret is not necessary for this login flow."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com"},"children":[]}]}]}],"flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"appointment_id","in":"path","schemaId":"schema_40","required":true}],"pointer":"/paths/~1v1~1appointments~1{appointment_id}~1attachments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/UploadAppointmentAttachmentRequest"}},"schemaId":"components/schemas/UploadAppointmentAttachmentRequest","pointer":"/paths/~1v1~1appointments~1{appointment_id}~1attachments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/appointments/{appointment_id}/attachments","servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"parameters":{"path":[{"name":"appointment_id","in":"path","required":true,"schemaId":"schema_40"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsFlow","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}],"scopes":["external.appointment.write"]},{"schemes":[{"id":"AuthorizationCodeFlow","type":"oauth2","flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}],"scopes":["external.appointment.write"]}],"requestBody":{"multipart/form-data":{"schemaId":"components/schemas/UploadAppointmentAttachmentRequest"}},"responseCodes":["200","400","401","403","404","500"],"pointer":"/v1/appointments/{appointment_id}/attachments","href":"appointments/uploadappointmentattachment","openApiOperationId":"uploadAppointmentAttachment","summary":"Create attachment for appointment","securityGroups":[{"ClientCredentialsFlow":["external.appointment.write"]},{"AuthorizationCodeFlow":["external.appointment.write"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"schemaId":"components/schemas/UploadAppointmentAttachmentRequest","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"components/schemas/UploadAppointmentAttachmentRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully uploaded attachment","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UploadAppointmentAttachmentResponse"}},"schemaId":"components/schemas/UploadAppointmentAttachmentResponse"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}},"schemaId":"components/schemas/ErrorResult"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}},"schemaId":"components/schemas/ErrorResult"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1v1~1appointments~1{appointment_id}~1attachments/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/UploadAppointmentAttachmentResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UploadAppointmentAttachmentResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}}},{"code":"401"},{"code":"403"},{"code":"404","schemaId":"components/schemas/ErrorResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/uploadappointmentattachment"}],"panels":[]}]},"httpPath":"/v1/appointments/{appointment_id}/attachments"},{"label":"Update appointment status","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/appointments/updateappointmentstatus","routeSlug":"/apis/appointments/updateappointmentstatus","metadata":{"seo":{"title":"Update appointment status","description":"Use this endpoint to update the status of an appointment to either 'arrived' or 'no_show'."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateAppointmentStatus","name":"Update appointment status","isWebhook":false,"pointer":"/paths/~1v1~1appointments~1update-status/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update appointment status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint to update the status of an appointment to either 'arrived' or 'no_show'."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"arrived"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Indicates the patient has arrived at the office."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"no_show"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Indicates the patient did not show up for their scheduled appointment. Appointment start time should be in the past but no older than 2 days to be marked as no_show."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsFlow","scopes":["external.appointment.write"],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Machine to machine authentication (for use from client server to Zocdoc)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com/oauth/token"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com/oauth/token"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}]},{"schemes":[{"name":"AuthorizationCodeFlow","scopes":["external.appointment.write"],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Log in as a user. Client Secret is not necessary for this login flow."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com"},"children":[]}]}]}],"flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExternalUpdateAppointmentStatusRequestBody"}},"schemaId":"components/schemas/ExternalUpdateAppointmentStatusRequestBody","pointer":"/paths/~1v1~1appointments~1update-status/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/appointments/update-status","servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsFlow","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}],"scopes":["external.appointment.write"]},{"schemes":[{"id":"AuthorizationCodeFlow","type":"oauth2","flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}],"scopes":["external.appointment.write"]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ExternalUpdateAppointmentStatusRequestBody"}},"responseCodes":["200","400","401","403","404","409","500"],"pointer":"/v1/appointments/update-status","href":"appointments/updateappointmentstatus","openApiOperationId":"updateAppointmentStatus","summary":"Update appointment status","securityGroups":[{"ClientCredentialsFlow":["external.appointment.write"]},{"AuthorizationCodeFlow":["external.appointment.write"]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"schemaId":"components/schemas/ExternalUpdateAppointmentStatusRequestBody","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ExternalUpdateAppointmentStatusRequestBody"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful status update","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentBaseResponse"}},"schemaId":"components/schemas/AppointmentBaseResponse"},{"code":"400","description":"Bad Request"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not found"},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}},"schemaId":"components/schemas/ErrorResult"},{"code":"500","description":"Internal Server Error"}],"pointer":"/paths/~1v1~1appointments~1update-status/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AppointmentBaseResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AppointmentBaseResponse"}}},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"404"},{"code":"409","schemaId":"components/schemas/ErrorResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}}},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appointments/updateappointmentstatus"}],"panels":[]}]},"httpPath":"/v1/appointments/update-status"}],"content":{"contentType":"group","meta":{"name":"appointments"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Appointments","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints for booking, cancelling, and rescheduling appointments, including retrieving current appointment statuses and updated information."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/appointments","summary":"Create appointment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appointments/createappointment","deprecated":false},{"title":"/v1/appointments","summary":"Get appointments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appointments/getappointments","deprecated":false},{"title":"/v1/appointments/{appointment_id}","summary":"Get appointment by id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appointments/getappointment","deprecated":false},{"title":"/v1/appointments/{appointment_id}/participants","summary":"Get participants for appointment","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appointments/getappointmentparticipants","deprecated":false},{"title":"/v1/appointments/cancel","summary":"Cancel appointment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appointments/cancelappointment","deprecated":false},{"title":"/v1/appointments/confirm","summary":"Confirm appointment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appointments/confirmappointment","deprecated":false},{"title":"/v1/appointments/reschedule","summary":"Reschedule appointment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appointments/rescheduleappointment","deprecated":false},{"title":"/v1/appointments/{appointment_id}/attachments","summary":"Create attachment for appointment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appointments/uploadappointmentattachment","deprecated":false},{"title":"/v1/appointments/update-status","summary":"Update appointment status","prefix":{"name":"put","color":"put"},"badges":[],"link":"/appointments/updateappointmentstatus","deprecated":false}]}]}]}]}},{"type":"group","label":"Webhook","link":"/apis/webhook","routeSlug":"/apis/webhook","items":[{"label":"Mock webhook request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/webhook/mockwebhookrequest","routeSlug":"/apis/webhook/mockwebhookrequest","metadata":{"seo":{"title":"Mock webhook request","description":"Mock webhook request"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"mockWebhookRequest","name":"Mock webhook request","isWebhook":false,"pointer":"/paths/~1v1~1webhook~1mock-request/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Mock webhook request","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsFlow","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Machine to machine authentication (for use from client server to Zocdoc)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com/oauth/token"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com/oauth/token"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}]},{"schemes":[{"name":"AuthorizationCodeFlow","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Log in as a user. Client Secret is not necessary for this login flow."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com"},"children":[]}]}]}],"flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebhookMockDataRequest"}},"schemaId":"components/schemas/WebhookMockDataRequest","pointer":"/paths/~1v1~1webhook~1mock-request/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/webhook/mock-request","servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsFlow","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}],"scopes":[]},{"schemes":[{"id":"AuthorizationCodeFlow","type":"oauth2","flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/WebhookMockDataRequest"}},"responseCodes":["200","400","401","403","404"],"pointer":"/v1/webhook/mock-request","href":"webhook/mockwebhookrequest","openApiOperationId":"mockWebhookRequest","summary":"Mock webhook request","securityGroups":[{"ClientCredentialsFlow":[]},{"AuthorizationCodeFlow":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"schemaId":"components/schemas/WebhookMockDataRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/WebhookMockDataRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookMockResponse"}},"schemaId":"components/schemas/WebhookMockResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}},"schemaId":"components/schemas/ErrorResult"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not found"}],"pointer":"/paths/~1v1~1webhook~1mock-request/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WebhookMockResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WebhookMockResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}}},{"code":"401"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook/mockwebhookrequest"}],"panels":[]}]},"httpPath":"/v1/webhook/mock-request"}],"content":{"contentType":"group","meta":{"name":"webhook"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Webhook","showPageActions":true},{"nodeType":"markdoc","content":"Sandbox endpoints to mock webhook behavior"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/webhook/mock-request","summary":"Mock webhook request","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhook/mockwebhookrequest","deprecated":false}]}]}]}]}},{"type":"group","label":"Specialties","link":"/apis/specialties","routeSlug":"/apis/specialties","items":[{"label":"Get specialties","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/specialties/getspecialties","routeSlug":"/apis/specialties/getspecialties","metadata":{"seo":{"title":"Get specialties","description":"Get specialties with optional filtering by care category"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSpecialties","name":"Get specialties","isWebhook":false,"pointer":"/paths/~1v1~1specialties/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get specialties","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get specialties with optional filtering by care category"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsFlow","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Machine to machine authentication (for use from client server to Zocdoc)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com/oauth/token"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com/oauth/token"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}]},{"schemes":[{"name":"AuthorizationCodeFlow","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Log in as a user. Client Secret is not necessary for this login flow."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com"},"children":[]}]}]}],"flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_42","description":"The zero indexed page of results. Default is 0. Maximum is 200."},{"name":"page_size","in":"query","schemaId":"schema_43","description":"The number of results to return per page. Default is 100. Maximum is 500."},{"name":"care_category","in":"query","schemaId":"schema_48","description":"Filter by care category"}],"pointer":"/paths/~1v1~1specialties/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/specialties","servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","schemaId":"schema_42"},{"name":"page_size","in":"query","schemaId":"schema_43"},{"name":"care_category","in":"query","schemaId":"components/schemas/CareCategory"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsFlow","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}],"scopes":[]},{"schemes":[{"id":"AuthorizationCodeFlow","type":"oauth2","flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/v1/specialties","href":"specialties/getspecialties","openApiOperationId":"getSpecialties","summary":"Get specialties","securityGroups":[{"ClientCredentialsFlow":[]},{"AuthorizationCodeFlow":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SpecialtiesResponse"}},"schemaId":"components/schemas/SpecialtiesResponse"},{"code":"400","description":"Invalid request parameters.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}},"schemaId":"components/schemas/ErrorResult"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not found"}],"pointer":"/paths/~1v1~1specialties/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SpecialtiesResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SpecialtiesResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}}},{"code":"401"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/specialties/getspecialties"}],"panels":[]}]},"httpPath":"/v1/specialties"},{"label":"Get specialty by id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/specialties/getspecialtybyid","routeSlug":"/apis/specialties/getspecialtybyid","metadata":{"seo":{"title":"Get specialty by id","description":"Get specialty by id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSpecialtyById","name":"Get specialty by id","isWebhook":false,"pointer":"/paths/~1v1~1specialties~1{specialty_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get specialty by id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get specialty by id"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsFlow","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Machine to machine authentication (for use from client server to Zocdoc)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com/oauth/token"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com/oauth/token"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}]},{"schemes":[{"name":"AuthorizationCodeFlow","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Log in as a user. Client Secret is not necessary for this login flow."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com"},"children":[]}]}]}],"flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"specialty_id","in":"path","schemaId":"schema_40","description":"Zocdoc specialty id","required":true}],"pointer":"/paths/~1v1~1specialties~1{specialty_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/specialties/{specialty_id}","servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"parameters":{"path":[{"name":"specialty_id","in":"path","required":true,"schemaId":"schema_40"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsFlow","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}],"scopes":[]},{"schemes":[{"id":"AuthorizationCodeFlow","type":"oauth2","flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/v1/specialties/{specialty_id}","href":"specialties/getspecialtybyid","openApiOperationId":"getSpecialtyById","summary":"Get specialty by id","securityGroups":[{"ClientCredentialsFlow":[]},{"AuthorizationCodeFlow":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SpecialtyByIdResponse"}},"schemaId":"components/schemas/SpecialtyByIdResponse"},{"code":"400","description":"Invalid request parameters.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}},"schemaId":"components/schemas/ErrorResult"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not found"}],"pointer":"/paths/~1v1~1specialties~1{specialty_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SpecialtyByIdResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SpecialtyByIdResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}}},{"code":"401"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/specialties/getspecialtybyid"}],"panels":[]}]},"httpPath":"/v1/specialties/{specialty_id}"}],"content":{"contentType":"group","meta":{"name":"specialties"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Specialties","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints to retrieve specialties supported by Zocdoc."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/specialties","summary":"Get specialties","prefix":{"name":"get","color":"get"},"badges":[],"link":"/specialties/getspecialties","deprecated":false},{"title":"/v1/specialties/{specialty_id}","summary":"Get specialty by id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/specialties/getspecialtybyid","deprecated":false}]}]}]}]}},{"type":"group","label":"Visit Reasons","link":"/apis/visit-reasons","routeSlug":"/apis/visit-reasons","items":[{"label":"Get visit reasons","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/visit-reasons/getvisitreasons","routeSlug":"/apis/visit-reasons/getvisitreasons","metadata":{"seo":{"title":"Get visit reasons","description":"Get visit reasons with optional filtering by specialty"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getVisitReasons","name":"Get visit reasons","isWebhook":false,"pointer":"/paths/~1v1~1visit_reasons/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get visit reasons","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get visit reasons with optional filtering by specialty"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsFlow","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Machine to machine authentication (for use from client server to Zocdoc)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com/oauth/token"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com/oauth/token"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}]},{"schemes":[{"name":"AuthorizationCodeFlow","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Log in as a user. Client Secret is not necessary for this login flow."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com"},"children":[]}]}]}],"flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_42","description":"The zero indexed page of results. Default is 0. Maximum is 200."},{"name":"page_size","in":"query","schemaId":"schema_43","description":"The number of results to return per page. Default is 100. Maximum is 500."},{"name":"specialty_id","in":"query","schemaId":"schema_40","description":"Filter by primary specialty id"}],"pointer":"/paths/~1v1~1visit_reasons/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/visit_reasons","servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","schemaId":"schema_42"},{"name":"page_size","in":"query","schemaId":"schema_43"},{"name":"specialty_id","in":"query","schemaId":"schema_40"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsFlow","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}],"scopes":[]},{"schemes":[{"id":"AuthorizationCodeFlow","type":"oauth2","flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/v1/visit_reasons","href":"visit-reasons/getvisitreasons","openApiOperationId":"getVisitReasons","summary":"Get visit reasons","securityGroups":[{"ClientCredentialsFlow":[]},{"AuthorizationCodeFlow":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VisitReasonsResponse"}},"schemaId":"components/schemas/VisitReasonsResponse"},{"code":"400","description":"Invalid request parameters.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}},"schemaId":"components/schemas/ErrorResult"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not found"}],"pointer":"/paths/~1v1~1visit_reasons/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/VisitReasonsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VisitReasonsResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}}},{"code":"401"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/visit-reasons/getvisitreasons"}],"panels":[]}]},"httpPath":"/v1/visit_reasons"},{"label":"Get visit reason by id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/visit-reasons/getvisitreasonbyid","routeSlug":"/apis/visit-reasons/getvisitreasonbyid","metadata":{"seo":{"title":"Get visit reason by id","description":"Get visit reason by id"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getVisitReasonById","name":"Get visit reason by id","isWebhook":false,"pointer":"/paths/~1v1~1visit_reasons~1{visit_reason_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get visit reason by id","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get visit reason by id"},{"nodeType":"security","requirements":[{"schemes":[{"name":"ClientCredentialsFlow","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Machine to machine authentication (for use from client server to Zocdoc)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com/oauth/token"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com/oauth/token"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}]},{"schemes":[{"name":"AuthorizationCodeFlow","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Log in as a user. Client Secret is not necessary for this login flow."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com"},"children":[]}]}]}],"flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"visit_reason_id","in":"path","schemaId":"schema_40","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zocdoc visit reason id (format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pc_*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pc_TlZW-r06U0W3pCsIGtSI5B"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1v1~1visit_reasons~1{visit_reason_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/visit_reasons/{visit_reason_id}","servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"parameters":{"path":[{"name":"visit_reason_id","in":"path","required":true,"schemaId":"schema_40"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"ClientCredentialsFlow","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}}],"scopes":[]},{"schemes":[{"id":"AuthorizationCodeFlow","type":"oauth2","flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}],"scopes":[]}],"responseCodes":["200","400","401","403","404"],"pointer":"/v1/visit_reasons/{visit_reason_id}","href":"visit-reasons/getvisitreasonbyid","openApiOperationId":"getVisitReasonById","summary":"Get visit reason by id","securityGroups":[{"ClientCredentialsFlow":[]},{"AuthorizationCodeFlow":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VisitReasonByIdResponse"}},"schemaId":"components/schemas/VisitReasonByIdResponse"},{"code":"400","description":"Invalid request parameters.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}},"schemaId":"components/schemas/ErrorResult"},{"code":"401","description":"Unauthorized"},{"code":"403","description":"Forbidden"},{"code":"404","description":"Not found"}],"pointer":"/paths/~1v1~1visit_reasons~1{visit_reason_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/VisitReasonByIdResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VisitReasonByIdResponse"}}},{"code":"400","schemaId":"components/schemas/ErrorResult","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorResult"}}},{"code":"401"},{"code":"403"},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/visit-reasons/getvisitreasonbyid"}],"panels":[]}]},"httpPath":"/v1/visit_reasons/{visit_reason_id}"}],"content":{"contentType":"group","meta":{"name":"visit-reasons"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Visit Reasons","showPageActions":true},{"nodeType":"markdoc","content":"Endpoints to retrieve visit reasons supported by Zocdoc."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/visit_reasons","summary":"Get visit reasons","prefix":{"name":"get","color":"get"},"badges":[],"link":"/visit-reasons/getvisitreasons","deprecated":false},{"title":"/v1/visit_reasons/{visit_reason_id}","summary":"Get visit reason by id","prefix":{"name":"get","color":"get"},"badges":[],"link":"/visit-reasons/getvisitreasonbyid","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/UpdateInsuranceMappingsRequest":{"id":"components/schemas/UpdateInsuranceMappingsRequest","kind":"json-schema","title":"UpdateInsuranceMappingsRequest","data":{"type":"object","required":["operation","insurance_plan_ids"],"properties":{"insurance_plan_ids":{"description":"List of insurance plan ids","type":"array","items":{"type":"string"}},"operation":{"$ref":"#/components/schemas/InsuranceMappingUpdateOperation"}}}},"components/schemas/InsuranceMappingUpdateOperation":{"id":"components/schemas/InsuranceMappingUpdateOperation","kind":"json-schema","title":"InsuranceMappingUpdateOperation","data":{"type":"string","enum":["Add","Remove","Replace"]}},"components/schemas/UpdateInsuranceMappingsResult":{"id":"components/schemas/UpdateInsuranceMappingsResult","kind":"json-schema","title":"UpdateInsuranceMappingsResult","data":{"allOf":[{"$ref":"#/components/schemas/BaseResult"}]}},"components/schemas/GetInsuranceMappingsResults":{"id":"components/schemas/GetInsuranceMappingsResults","kind":"json-schema","title":"GetInsuranceMappingsResults","data":{"allOf":[{"$ref":"#/components/schemas/BaseResult"},{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/InsuranceMappingData"}}}]}},"components/schemas/InsuranceMappingData":{"id":"components/schemas/InsuranceMappingData","kind":"json-schema","title":"InsuranceMappingData","data":{"type":"object","required":["insurance_plan_mappings","eligible_insurances"],"properties":{"insurance_plan_mappings":{"description":"List of insurance plans that are mapped","type":"array","items":{"$ref":"#/components/schemas/InsurancePlanMapping"}},"eligible_insurances":{"description":"List of insurance networks and their plans that can be mapped","type":"array","items":{"$ref":"#/components/schemas/EligibleInsurance"}}}}},"components/schemas/InsurancePlanMapping":{"id":"components/schemas/InsurancePlanMapping","kind":"json-schema","title":"InsurancePlanMapping","data":{"type":"object","required":["insurance_plan_id"],"properties":{"insurance_plan_id":{"type":"string"}}}},"components/schemas/EligibleInsurance":{"id":"components/schemas/EligibleInsurance","kind":"json-schema","title":"EligibleInsurance","data":{"type":"object","required":["insurance_carrier_id","insurance_carrier_networks"],"properties":{"insurance_carrier_id":{"type":"string"},"insurance_carrier_networks":{"type":"array","items":{"$ref":"#/components/schemas/InsuranceCarrierNetwork"}}}}},"components/schemas/InsuranceCarrierNetwork":{"id":"components/schemas/InsuranceCarrierNetwork","kind":"json-schema","title":"InsuranceCarrierNetwork","data":{"type":"object","required":["program_type","network_type","insurance_plan_ids"],"properties":{"program_type":{"type":"string"},"network_type":{"type":"string"},"insurance_plan_ids":{"type":"array","items":{"type":"string"}}}}},"components/schemas/AcceptsPatientInsuranceType":{"id":"components/schemas/AcceptsPatientInsuranceType","kind":"json-schema","title":"AcceptsPatientInsuranceType","data":{"type":"string","description":"Whether the provider location accepts the patient's insurance","enum":["accepted","not_accepted","insurance_not_specified"]}},"components/schemas/AppointmentBaseResponse":{"id":"components/schemas/AppointmentBaseResponse","kind":"json-schema","title":"AppointmentBaseResponse","data":{"allOf":[{"$ref":"#/components/schemas/BaseResult"},{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/AppointmentBaseResponseData"}}}]}},"components/schemas/AppointmentBaseResponseData":{"id":"components/schemas/AppointmentBaseResponseData","kind":"json-schema","title":"AppointmentBaseResponseData","data":{"required":["appointment_status","appointment_id"],"type":"object","description":"Data that will be returned upon a sucessful booking request","properties":{"appointment_id":{"type":"string","description":"The Zocdoc ID of the appointment."},"appointment_status":{"$ref":"#/components/schemas/AppointmentStatus"},"developer_patient_id":{"type":"string","description":"The patient identifier provided by 3P developer. Null if not provided."}}}},"components/schemas/AppointmentData":{"id":"components/schemas/AppointmentData","kind":"json-schema","title":"AppointmentData","data":{"required":["start_time","visit_reason_id","provider_location_id","patient","patient_type"],"type":"object","properties":{"start_time":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date & time of the appointment in ISO-8601 format with a timezone offset. Must be a valid start time from the /v1/provider_locations/availability endpoint."},"children":[]}]}]}],"example":"2022-04-27T09:00:00-04:00"},"visit_reason_id":{"type":"string","description":"The Zocdoc visit reason ID for the appointment. Must be accepted by the provider.","example":"pc_FRO-18leckytNKtruw5dLR"},"provider_location_id":{"type":"string","description":"The Zocdoc provider-location ID for the appointment.","example":"pr_abc123-def456_wxyz7890|lo_abc123-def456_wxyz7890"},"patient":{"$ref":"#/components/schemas/Patient"},"patient_type":{"$ref":"#/components/schemas/PatientType"},"notes":{"type":"string","description":"Patient notes. 100 character maximum limit."}}}},"components/schemas/AppointmentResponse":{"id":"components/schemas/AppointmentResponse","kind":"json-schema","title":"AppointmentResponse","data":{"allOf":[{"$ref":"#/components/schemas/BaseResult"},{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/AppointmentResponseData"}}}]}},"components/schemas/AppointmentResponseData":{"id":"components/schemas/AppointmentResponseData","kind":"json-schema","title":"AppointmentResponseData","data":{"allOf":[{"$ref":"#/components/schemas/SharedAppointmentResponseData"},{"type":"object","required":["visit_type"],"properties":{"visit_type":{"$ref":"#/components/schemas/AppointmentVisitType"},"notes":{"type":"string","description":"Patient notes. 100 character maximum limit."}},"description":"Data that will be returned upon a sucessful booking request"}]}},"components/schemas/AppointmentParticipantsResponse":{"id":"components/schemas/AppointmentParticipantsResponse","kind":"json-schema","title":"AppointmentParticipantsResponse","data":{"allOf":[{"$ref":"#/components/schemas/BaseResult"},{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/AppointmentParticipantsResponseData"}}}]}},"components/schemas/AppointmentParticipantsResponseData":{"id":"components/schemas/AppointmentParticipantsResponseData","kind":"json-schema","title":"AppointmentParticipantsResponseData","data":{"type":"object","required":["patient","provider_id","location_id"],"properties":{"patient":{"$ref":"#/components/schemas/AppointmentParticipantPatient"},"provider_id":{"type":"string","description":"The Zocdoc id of the provider"},"location_id":{"type":"string","description":"The Zocdoc id of the location"}}}},"components/schemas/AppointmentStatusListResponse":{"id":"components/schemas/AppointmentStatusListResponse","kind":"json-schema","title":"AppointmentStatusListResponse","data":{"allOf":[{"$ref":"#/components/schemas/PaginatedBaseResult"},{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AppointmentStatusResponseData"}}}}]}},"components/schemas/AppointmentStatusResponse":{"id":"components/schemas/AppointmentStatusResponse","kind":"json-schema","title":"AppointmentStatusResponse","data":{"allOf":[{"$ref":"#/components/schemas/BaseResult"},{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/AppointmentStatusResponseData"}}}]}},"components/schemas/AppointmentStatusResponseData":{"id":"components/schemas/AppointmentStatusResponseData","kind":"json-schema","title":"AppointmentStatusResponseData","data":{"allOf":[{"$ref":"#/components/schemas/SharedAppointmentResponseData"},{"required":["start_time","provider_location_id","visit_reason_id"],"type":"object","description":"Data that will be returned upon an a appointment lookup","properties":{"start_time":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date & time of the appointment"},"children":[]}]}]}],"example":"2022-04-27T09:00:00-04:00"},"created_time_utc":{"type":"string","format":"instant","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UTC date & time of the appointment creation"},"children":[]}]}]}],"example":"2024-01-01T09:30:00Z"},"last_modified_time_utc":{"type":"string","format":"instant","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UTC date & time of the appointment last modification"},"children":[]}]}]}],"example":"2024-01-01T09:30:00Z"},"provider_location_id":{"type":"string"},"practice_id":{"type":"string","description":"The Zocdoc id of the practice"},"visit_reason_id":{"type":"string"},"visit_type":{"$ref":"#/components/schemas/AppointmentVisitType"},"patient_type":{"$ref":"#/components/schemas/PatientType"},"notes":{"type":"string","description":"Patient notes. 100 character maximum limit."},"cancellation_reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional free text description for the appointment cancellation. Only use this field when cancellation_reason_type is set to 'other_patient_reason' or 'other_provider_reason'."},"children":[]}]}]}]},"source":{"type":"string","description":"The channel where the appointment was booked (e.g., \"Zocdoc Marketplace\", \"Your website\")."}}}]}},"components/schemas/AppointmentType":{"id":"components/schemas/AppointmentType","kind":"json-schema","title":"AppointmentType","data":{"type":"string","enum":["providers"],"description":"The type of appointment."}},"components/schemas/AppointmentUpdateType":{"id":"components/schemas/AppointmentUpdateType","kind":"json-schema","title":"AppointmentUpdateType","data":{"type":"string","enum":["updated","cancelled","created"]}},"components/schemas/AppointmentVisitType":{"id":"components/schemas/AppointmentVisitType","kind":"json-schema","title":"AppointmentVisitType","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The appointment's "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/glossary"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"visit type"},"children":[]}]}]}]}],"enum":["in_person","zocdoc_video_service","third_party_video_service"]}},"components/schemas/AppointmentSortByType":{"id":"components/schemas/AppointmentSortByType","kind":"json-schema","title":"AppointmentSortByType","data":{"type":"string","enum":["start_time_utc","created_time_utc","last_modified_time_utc"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field to sort appointments by:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"start_time_utc - Sort by appointment start time (default)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"created_time_utc - Sort by when appointment was created"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"last_modified_time_utc - Sort by when appointment was last modified"},"children":[]}]}]}]}]}},"components/schemas/AppointmentSortDirectionType":{"id":"components/schemas/AppointmentSortDirectionType","kind":"json-schema","title":"AppointmentSortDirectionType","data":{"type":"string","enum":["ascending","descending"]}},"components/schemas/Availability":{"id":"components/schemas/Availability","kind":"json-schema","title":"Availability","data":{"type":"object","properties":{"provider_location_id":{"type":"string","description":"The Zocdoc provider location ID for the availability.","example":"pr_abc123-def456_wxyz7890|lo_abc123-def456_wxyz7890"},"first_availability":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The provider location's next open slot for the requested "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"visit_reason_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"patient_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Searched forward from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_date_in_provider_local_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or today, whichever is later."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not bounded by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"end_date_in_provider_local_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This slot can fall after the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"requested window while "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timeslots"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is empty; inside the window it is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timeslots[0]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when the provider location has no upcoming availability for that"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"visit_reason_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"patient_type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass its "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" verbatim, offset included, as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.start_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST /v1/appointments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To retrieve this slot in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timeslots"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", re-query with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"start_date_in_provider_local_time"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set to its date."},"children":[]}]}]}],"$ref":"#/components/schemas/Timeslot"},"timeslots":{"type":"array","items":{"$ref":"#/components/schemas/Timeslot"}}}}},"components/schemas/AvailabilityResult":{"id":"components/schemas/AvailabilityResult","kind":"json-schema","title":"AvailabilityResult","data":{"allOf":[{"$ref":"#/components/schemas/BaseResult"},{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Availability"},"description":"Response containing the availaibility information."}}}]}},"components/schemas/BaseLocation":{"id":"components/schemas/BaseLocation","kind":"json-schema","title":"BaseLocation","data":{"type":"object","required":["address1","city","state","zip_code","latitude","longitude"],"properties":{"address1":{"type":"string"},"address2":{"type":"string"},"city":{"type":"string"},"state":{"description":"The location's two letter state code.","example":"NY","type":"string"},"zip_code":{"description":"The location's 5 digit zip code.","type":"string"},"latitude":{"type":"number","format":"float"},"longitude":{"type":"number","format":"float"},"location_name":{"type":"string"},"phone_number":{"type":"string","description":"Unformatted phone number for the location. Returns null for certain API products.","example":"9999999999"},"phone_extension":{"type":"string","description":"Unformatted extension digits for the location phone number.","example":"123"},"time_zone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IANA time zone identifier for the location, e.g., America/New_York."},"children":[]}]}]}],"example":"America/New_York"}}}},"components/schemas/BaseLocationWithDistance":{"id":"components/schemas/BaseLocationWithDistance","kind":"json-schema","title":"BaseLocationWithDistance","data":{"allOf":[{"$ref":"#/components/schemas/BaseLocation"},{"type":"object","properties":{"distance_to_patient_mi":{"type":"number","format":"float","description":"Distance from patient to provider in miles."}}}]}},"components/schemas/BaseProvider":{"id":"components/schemas/BaseProvider","kind":"json-schema","title":"BaseProvider","data":{"type":"object","properties":{"provider_id":{"type":"string","description":"The Zocdoc provider ID"},"npi":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"title":{"type":"string"},"full_name":{"type":"string"},"gender_identity":{"type":"string","description":"Possible values include: Female, Male, Non-binary"},"specialties":{"type":"array","items":{"type":"string"}},"specialty_ids":{"type":"array","items":{"type":"string"}},"default_visit_reason_id":{"type":"string"},"visit_reason_ids":{"type":"array","items":{"type":"string"}},"statement":{"type":"string"},"provider_photo_url":{"type":"string","description":"Protocol-relative URL to a provider's photo. URL will change if a new photo is uploaded. Only 1 photo URL will be given at a time. Photos should be 200-4,000 pixels. JPEG and PNG formats are accepted. Photos are reviewed at time of upload and on an annual basis.","example":"//d2uur722ua7fvv.cloudfront.net/ZeeFace_02.svg"},"languages":{"type":"array","items":{"type":"string"},"description":"Languages spoken at the practice location, might be facilitated by translators on site.","example":["English","Spanish"]},"profile_url":{"type":"string","description":"The URL to view the providers profile on Zocdoc.","example":"https://zocdoc.com/doctor/capivarudo-nojeira-md-517507?utm_source=FakeSource"},"credentials":{"$ref":"#/components/schemas/ProviderCredentials"}}}},"components/schemas/BaseProviderDetailsLocation":{"id":"components/schemas/BaseProviderDetailsLocation","kind":"json-schema","title":"BaseProviderDetailsLocation","data":{"type":"object","required":["provider_location_id","accepts_patient_insurance","booking_requirements"],"properties":{"provider_location_id":{"type":"string","example":"pr_abc123-def456_wxyz7890|lo_abc123-def456_wxyz7890"},"accepts_patient_insurance":{"$ref":"#/components/schemas/AcceptsPatientInsuranceType"},"first_availability_date_in_provider_local_time":{"type":"string","format":"date","description":"The first date where provider has availability for new patients with any visit reason in provider's local time zone, formatted as YYYY-MM-DD and up to 90 days in the future."},"booking_requirements":{"$ref":"#/components/schemas/BookingRequirements"}}}},"components/schemas/BaseVirtualLocation":{"id":"components/schemas/BaseVirtualLocation","kind":"json-schema","title":"BaseVirtualLocation","data":{"type":"object","required":["state"],"properties":{"state":{"description":"The location's two letter state code.","example":"NY","type":"string"},"location_name":{"type":"string"},"time_zone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IANA time zone identifier for the location, e.g., America/New_York."},"children":[]}]}]}],"example":"America/New_York"}}}},"components/schemas/BookAppointmentRequestBody":{"id":"components/schemas/BookAppointmentRequestBody","kind":"json-schema","title":"BookAppointmentRequestBody","data":{"required":["appointment_type","data"],"type":"object","properties":{"appointment_type":{"$ref":"#/components/schemas/AppointmentType"},"data":{"$ref":"#/components/schemas/AppointmentData"}}}},"components/schemas/BookingRequestInsuranceSource":{"id":"components/schemas/BookingRequestInsuranceSource","kind":"json-schema","title":"BookingRequestInsuranceSource","data":{"type":"string","description":"The types of insurance coverage that a provider accepts","enum":["in_network","out_of_network","self_pay"]}},"components/schemas/BookingRequirements":{"id":"components/schemas/BookingRequirements","kind":"json-schema","title":"BookingRequirements","data":{"type":"object","required":["required_fields","accepts_booking_requests_from"],"properties":{"required_fields":{"type":"array","items":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Options include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.patient.insurance.insurance_plan_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.patient.insurance.insurance_member_id"},"children":[]}]}]}]}},"accepts_booking_requests_from":{"type":"array","items":{"$ref":"#/components/schemas/BookingRequestInsuranceSource"}}},"description":"Criteria for booking appointments, defines requirements and mandatory fields specified by Zocdoc providers"}},"components/schemas/BuildingType":{"id":"components/schemas/BuildingType","kind":"json-schema","title":"BuildingType","data":{"type":"string","description":"The type of facility building, which can be clinic or hospital.","enum":["clinic","hospital"]}},"components/schemas/CancelAppointmentRequestBody":{"id":"components/schemas/CancelAppointmentRequestBody","kind":"json-schema","title":"CancelAppointmentRequestBody","data":{"type":"object","required":["appointment_id"],"properties":{"appointment_id":{"type":"string","description":"The Zocdoc ID of the appointment.","example":"d04b049a-41b1-4aba-9268-d8973cf72cdd"},"cancellation_reason":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional free text description for the appointment cancellation. Only use this field when cancellation_reason_type is set to 'other_patient_reason' or 'other_provider_reason'."},"children":[]}]}]}]},"cancellation_reason_type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enum field describing why the appointment was cancelled. This field is optional but recommended when known for metrics purposes. If the cancellation reason does not match any predefined enum values, use 'other_patient_reason' or 'other_provider_reason' and provide a free text explanation in the cancellation_reason field."},"children":[]}]}]}],"$ref":"#/components/schemas/CancellationReasonType"}}}},"components/schemas/CancellationReasonType":{"id":"components/schemas/CancellationReasonType","kind":"json-schema","title":"CancellationReasonType","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enum field describing why the appointment was cancelled. This field is optional but recommended when known for metrics purposes. If the cancellation reason does not match any predefined enum values, use 'other_patient_reason' or 'other_provider_reason' and provide a free text explanation in the cancellation_reason field."},"children":[]}]}]}],"enum":["patient_no_longer_needs_appointment","patient_no_longer_available","other_patient_reason","missing_needed_patient_information","payment_or_insurance_issue","patient_or_visit_type_not_accepted","provider_not_available","rescheduling_patient","other_provider_reason"]}},"components/schemas/ConfirmAppointmentRequestBody":{"id":"components/schemas/ConfirmAppointmentRequestBody","kind":"json-schema","title":"ConfirmAppointmentRequestBody","data":{"type":"object","required":["appointment_id"],"properties":{"appointment_id":{"type":"string","example":"d04b049a-41b1-4aba-9268-d8973cf72cdd"}}}},"components/schemas/CareCategory":{"id":"components/schemas/CareCategory","kind":"json-schema","title":"CareCategory","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The category of care for an insurance plan"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Health: Health and Mental Health Care"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dental: Dental Care"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Vision: Vision Care"},"children":[]}]}]}]}],"enum":["health","dental","vision"]}},"components/schemas/CoverageArea":{"id":"components/schemas/CoverageArea","kind":"json-schema","title":"CoverageArea","data":{"type":"object","required":["is_national"],"properties":{"is_national":{"type":"boolean"},"states":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The two letter state codes where the insurance plan has coverage. Will be null when is_national true."},"children":[]}]}]}],"items":{"type":"string"}}}}},"components/schemas/DeepProfileProvider":{"id":"components/schemas/DeepProfileProvider","kind":"json-schema","title":"DeepProfileProvider","data":{"type":"object","required":["first_name","last_name","title","prenominal","postnominal","full_name","gender_identity","specialties","specialty_ids","visit_reason_ids"],"properties":{"first_name":{"type":"string"},"last_name":{"type":"string"},"title":{"type":"string"},"prenominal":{"type":"string"},"postnominal":{"type":"string"},"full_name":{"type":"string"},"gender_identity":{"type":"string"},"specialties":{"type":"array","items":{"type":"string"}},"specialty_ids":{"type":"array","items":{"type":"string"}},"default_visit_reason_id":{"type":"string"},"visit_reason_ids":{"type":"array","items":{"type":"string"}},"provider_photo_url":{"type":"string"},"languages":{"type":"array","items":{"type":"string"}},"statement":{"type":"string"},"credentials":{"$ref":"#/components/schemas/ProviderCredentials"}}}},"components/schemas/DeepProfileProviderResult":{"id":"components/schemas/DeepProfileProviderResult","kind":"json-schema","title":"DeepProfileProviderResult","data":{"allOf":[{"$ref":"#/components/schemas/BaseResult"},{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DeepProfileProvider"}}}}]}},"components/schemas/Education":{"id":"components/schemas/Education","kind":"json-schema","title":"Education","data":{"type":"object","properties":{"institutions":{"type":"array","items":{"type":"string"}}}}},"components/schemas/FacilitiesResponse":{"id":"components/schemas/FacilitiesResponse","kind":"json-schema","title":"FacilitiesResponse","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/PaginatedBaseResult"},{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Facility"}}}}]}},"components/schemas/Facility":{"id":"components/schemas/Facility","kind":"json-schema","title":"Facility","data":{"type":"object","required":["facility_id","name","specialties","languages","visit_reason_ids","location","schedule"],"properties":{"facility_id":{"type":"string","description":"Zocdoc id for facility"},"name":{"type":"string"},"npi":{"type":"string"},"building_type":{"type":"string"},"specialties":{"type":"array","items":{"type":"string"}},"languages":{"type":"array","items":{"type":"string"}},"visit_reason_ids":{"type":"array","items":{"type":"string"}},"default_visit_reason_id":{"type":"string"},"location":{"$ref":"#/components/schemas/BaseLocation"},"schedule":{"$ref":"#/components/schemas/FacilitySchedule"},"practice":{"$ref":"#/components/schemas/Practice"}}}},"components/schemas/FacilityByIdResponse":{"id":"components/schemas/FacilityByIdResponse","kind":"json-schema","title":"FacilityByIdResponse","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseResult"},{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Facility"}}}]}},"components/schemas/FacilitySchedule":{"id":"components/schemas/FacilitySchedule","kind":"json-schema","title":"FacilitySchedule","data":{"type":"object","required":["schedule_id","provider_location_id","booking_requirements"],"properties":{"schedule_id":{"type":"string","description":"Zocdoc id for bookable schedule"},"provider_location_id":{"type":"string","description":"Zocdoc provider location id for availability and booking requests"},"booking_requirements":{"$ref":"#/components/schemas/BookingRequirements"}}}},"components/schemas/InsuranceCarrier":{"id":"components/schemas/InsuranceCarrier","kind":"json-schema","title":"InsuranceCarrier","data":{"type":"object","description":"The insurance carrier for the insurance plan","required":["id","name"],"properties":{"id":{"type":"string","description":"Zocdoc id for insurance carrier"},"name":{"type":"string"}}}},"components/schemas/InsuranceNetworkType":{"id":"components/schemas/InsuranceNetworkType","kind":"json-schema","title":"InsuranceNetworkType","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of insurance plan"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HMO: Health Maintenance Organization"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"PPO: Preferred Provider Organization"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"POS: Point-of-Service"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"EPO: Exclusive Provider Organization"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indemnity: Traditional fee-for-service plans"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ASO: Administrative Services Only"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACO: Accountable Care Organizations"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACP: Accountable Care Program"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Medicare: Medicare Advantage plans"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Medicaid: Medicaid Managed Care plans"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Other"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Uncategorized: Uncategorized insurance plans"},"children":[]}]}]}]}],"enum":["hmo","ppo","pos","epo","indemnity","aso","aco","acp","medicare","medicaid","other","uncategorized","hmo_pos"]}},"components/schemas/InsurancePlan":{"id":"components/schemas/InsurancePlan","kind":"json-schema","title":"InsurancePlan","data":{"type":"object","required":["id","name","carrier","network_type","program_type","care_categories","status","coverage_area","ref_metadata"],"properties":{"id":{"type":"string","description":"Zocdoc id for insurance plan"},"name":{"type":"string"},"carrier":{"$ref":"#/components/schemas/InsuranceCarrier"},"network_type":{"$ref":"#/components/schemas/InsuranceNetworkType"},"program_type":{"$ref":"#/components/schemas/InsuranceProgramType"},"status":{"$ref":"#/components/schemas/InsuranceStatus"},"care_categories":{"type":"array","items":{"$ref":"#/components/schemas/CareCategory"}},"coverage_area":{"$ref":"#/components/schemas/CoverageArea"},"ref_metadata":{"$ref":"#/components/schemas/ReferenceMetadata"}}}},"components/schemas/InsurancePlanByIdResponse":{"id":"components/schemas/InsurancePlanByIdResponse","kind":"json-schema","title":"InsurancePlanByIdResponse","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseResult"},{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/InsurancePlan"}}}]}},"components/schemas/SpecialtyData":{"id":"components/schemas/SpecialtyData","kind":"json-schema","title":"SpecialtyData","data":{"type":"object","required":["id","name","care_category","default_visit_reason_id","default_visit_reason_name"],"properties":{"id":{"type":"string","description":"Zocdoc specialty id"},"name":{"type":"string"},"care_category":{"$ref":"#/components/schemas/CareCategory"},"default_visit_reason_id":{"type":"string"},"default_visit_reason_name":{"type":"string"}}}},"components/schemas/SpecialtyByIdResponse":{"id":"components/schemas/SpecialtyByIdResponse","kind":"json-schema","title":"SpecialtyByIdResponse","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseResult"},{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SpecialtyData"}}}]}},"components/schemas/SpecialtiesResponse":{"id":"components/schemas/SpecialtiesResponse","kind":"json-schema","title":"SpecialtiesResponse","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/PaginatedBaseResult"},{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SpecialtyData"}}}}]}},"components/schemas/VisitReasonData":{"id":"components/schemas/VisitReasonData","kind":"json-schema","title":"VisitReasonData","data":{"type":"object","required":["id","name","specialty_id"],"properties":{"id":{"type":"string","description":"Zocdoc visit reason id"},"name":{"type":"string"},"specialty_id":{"type":"string","description":"Zocdoc specialty id this visit reason belongs to"}}}},"components/schemas/VisitReasonByIdResponse":{"id":"components/schemas/VisitReasonByIdResponse","kind":"json-schema","title":"VisitReasonByIdResponse","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/BaseResult"},{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/VisitReasonData"}}}]}},"components/schemas/VisitReasonsResponse":{"id":"components/schemas/VisitReasonsResponse","kind":"json-schema","title":"VisitReasonsResponse","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/PaginatedBaseResult"},{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/VisitReasonData"}}}}]}},"components/schemas/InsuranceProgramType":{"id":"components/schemas/InsuranceProgramType","kind":"json-schema","title":"InsuranceProgramType","data":{"type":"string","enum":["commercial","commercial_exchange","medicare","medicaid","workers_compensation","uncategorized","medicare_advantage","medicaid_managed_care","federal"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"We've categorized plan types offered by each carrier into their associated programs:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commercial: The most common plans offered by private companies. Providers contract directly with the private insurance company."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACA Marketplace (Commercial exchange): Plans available for patients to buy on online marketplaces under the Affordable Care Act. Providers contract with the insurance carrier offering the plan, not the marketplace itself."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Medicare: Medicare advantage plans, sometimes called “Part C” or “MA Plans,” are offered by private companies approved by Medicare. They provide coverage to individuals, families, and employer groups, typically through employer-sponsored plans."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Medicaid: Medicaid Managed Care plans provide Medicaid benefits through contracted arrangements between state Medicaid agencies and a managed care organization (MCOs)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Worker's Compensation: State-mandated programs for work-related injuries and illnesses. Providers contract with the employer or a state-designated agency."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Uncategorized: Uncategorized insurance plans"},"children":[]}]}]}]}]}},"components/schemas/InsurancePlansResponse":{"id":"components/schemas/InsurancePlansResponse","kind":"json-schema","title":"InsurancePlansResponse","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/PaginatedBaseResult"},{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/InsurancePlan"}}}}]}},"components/schemas/InsuranceStatus":{"id":"components/schemas/InsuranceStatus","kind":"json-schema","title":"InsuranceStatus","data":{"type":"string","description":"Status of the insurance plan","enum":["inactive","active","deleted"]}},"components/schemas/Location":{"id":"components/schemas/Location","kind":"json-schema","title":"Location","data":{"allOf":[{"$ref":"#/components/schemas/BaseProviderDetailsLocation"},{"$ref":"#/components/schemas/BaseLocationWithDistance"},{"type":"object","properties":{"is_nearest_match":{"type":"boolean","description":"True for the location closest to the provided latitude/longitude. Only populated when latitude and longitude query parameters are provided."}}}]}},"components/schemas/PaginatedBaseResult":{"id":"components/schemas/PaginatedBaseResult","kind":"json-schema","title":"PaginatedBaseResult","data":{"allOf":[{"$ref":"#/components/schemas/BaseResult"},{"type":"object","required":["page","page_size","total_count","next_url"],"properties":{"page":{"description":"The zero based index of the current page.","type":"integer"},"page_size":{"description":"The size of the current page.","type":"integer"},"total_count":{"description":"The total number of result items.","type":"integer"},"next_url":{"description":"A link to the next page of results; null if this is the last page of results.","type":"string"}}}]}},"components/schemas/Patient":{"id":"components/schemas/Patient","kind":"json-schema","title":"Patient","data":{"required":["first_name","last_name","date_of_birth","sex_at_birth","phone_number","email_address","patient_address"],"type":"object","properties":{"patient_id":{"type":"string","description":"The Zocdoc ID of the patient."},"developer_patient_id":{"type":"string","description":"The patient identifier provided by 3P developer."},"first_name":{"type":"string","description":"The patient's first name."},"last_name":{"type":"string","description":"The patient's last name."},"date_of_birth":{"type":"string","format":"date","description":"The patient's date of birth in the format, YYYY-MM-DD."},"sex_at_birth":{"$ref":"#/components/schemas/PatientSex"},"phone_number":{"type":"string","description":"The patient's unformatted 10 digit phone number. The first and fourth digits cannot be a 0 or 1.","example":"9999999999"},"email_address":{"type":"string","description":"The patient's email address.","example":"test@example.com"},"patient_address":{"$ref":"#/components/schemas/PatientAddress"},"insurance":{"$ref":"#/components/schemas/PatientInsurance"},"gender":{"type":"array","items":{"$ref":"#/components/schemas/Gender"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"none_apply and prefer_not_to_say must be used independently, all other gender identities can be used in combination with each other."},"children":[]}]}]}]}}}},"components/schemas/AppointmentParticipantPatient":{"id":"components/schemas/AppointmentParticipantPatient","kind":"json-schema","title":"AppointmentParticipantPatient","data":{"allOf":[{"$ref":"#/components/schemas/Patient"},{"type":"object","required":["uploaded_attachments","is_booked_by_another_patient"],"properties":{"uploaded_attachments":{"type":"array","items":{"$ref":"#/components/schemas/UploadedAttachment"},"description":"Documents and files that have been uploaded by the patient for this appointment, such as insurance cards, ID cards, or intake forms."},"is_booked_by_another_patient":{"type":"boolean","description":"Indicates whether this patient's appointment was booked by another patient (e.g., a parent booking for their child or someone booking for a dependent)"}}}]}},"components/schemas/PatientAddress":{"id":"components/schemas/PatientAddress","kind":"json-schema","title":"PatientAddress","data":{"required":["address1","city","state","zip_code"],"type":"object","properties":{"address1":{"type":"string","description":"The patient's address, line 1."},"city":{"type":"string","description":"The patient's address, city."},"state":{"type":"string","description":"The patient's address, two letter state code.","example":"NY"},"zip_code":{"type":"string","description":"The patient's address, 5 digit zip code.","example":36925},"address2":{"type":"string","description":"The patient's address, line 2."}}}},"components/schemas/PatientInsurance":{"id":"components/schemas/PatientInsurance","kind":"json-schema","title":"PatientInsurance","data":{"type":"object","properties":{"insurance_plan_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the patient's insurance plan. Use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"#operation/getInsurancePlans"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get Insurance Plans"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint to retrieve available plans."},"children":[]}]}]}],"example":"ip_31820"},"insurance_group_number":{"type":"string","description":"The patients insurance group number."},"insurance_member_id":{"type":"string","description":"The patients insurance card member ID."},"is_self_pay":{"type":"boolean","description":"Indicates is a patient is self paying"}}}},"components/schemas/UploadedAttachment":{"id":"components/schemas/UploadedAttachment","kind":"json-schema","title":"UploadedAttachment","data":{"type":"object","required":["attachment_type","attachment_url"],"properties":{"attachment_type":{"$ref":"#/components/schemas/UploadedAttachmentType"},"attachment_url":{"type":"string","description":"A full URL to download the attachment pointing to one of auxiliary endpoints in the same API. To access the url the same authentication must be used as the one used to make the request to /participants endpoint."},"side":{"$ref":"#/components/schemas/DocumentSide"}}}},"components/schemas/DocumentSide":{"id":"components/schemas/DocumentSide","kind":"json-schema","title":"DocumentSide","data":{"type":"string","description":"Indicates whether the document image is of the front or back side. This field is typically used for documents like insurance cards or ID cards that have information on both sides.","enum":["front","back"]}},"components/schemas/Practice":{"id":"components/schemas/Practice","kind":"json-schema","title":"Practice","data":{"type":"object","required":["practice_id","practice_name"],"properties":{"practice_id":{"type":"string"},"practice_name":{"type":"string"}}}},"components/schemas/ProviderCredentials":{"id":"components/schemas/ProviderCredentials","kind":"json-schema","title":"ProviderCredentials","data":{"type":"object","required":["certifications","education"],"properties":{"certifications":{"type":"array","items":{"type":"string"}},"education":{"$ref":"#/components/schemas/Education"}},"description":"Provider Credentials include education and certifications."}},"components/schemas/ProviderDetails":{"id":"components/schemas/ProviderDetails","kind":"json-schema","title":"ProviderDetails","data":{"allOf":[{"$ref":"#/components/schemas/BaseProvider"},{"type":"object","required":["locations","virtual_locations","practice"],"properties":{"locations":{"type":"array","items":{"$ref":"#/components/schemas/Location"}},"virtual_locations":{"type":"array","items":{"$ref":"#/components/schemas/VirtualLocation"}},"practice":{"$ref":"#/components/schemas/Practice"}}}]}},"components/schemas/ProviderListResult":{"id":"components/schemas/ProviderListResult","kind":"json-schema","title":"ProviderListResult","data":{"allOf":[{"$ref":"#/components/schemas/PaginatedBaseResult"},{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/ProviderSearchResult"}}}]}},"components/schemas/ProviderLocation":{"id":"components/schemas/ProviderLocation","kind":"json-schema","title":"ProviderLocation","data":{"type":"object","required":["provider_location_id","provider_location_type","accepts_patient_insurance","provider","booking_requirements"],"properties":{"provider_location_id":{"type":"string","example":"pr_abc123-def456_wxyz7890|lo_abc123-def456_wxyz7890"},"provider_location_type":{"$ref":"#/components/schemas/ProviderLocationType"},"accepts_patient_insurance":{"$ref":"#/components/schemas/AcceptsPatientInsuranceType"},"first_availability_date_in_provider_local_time":{"type":"string","format":"date","description":"The first date where provider has availability for new patients with any visit reason in provider's local time zone, formatted as YYYY-MM-DD and up to 90 days in the future."},"provider":{"$ref":"#/components/schemas/BaseProvider"},"location":{"$ref":"#/components/schemas/BaseLocationWithDistance"},"virtual_location":{"$ref":"#/components/schemas/BaseVirtualLocation"},"practice":{"$ref":"#/components/schemas/Practice"},"booking_requirements":{"$ref":"#/components/schemas/BookingRequirements"}}}},"components/schemas/ProviderLocationResult":{"id":"components/schemas/ProviderLocationResult","kind":"json-schema","title":"ProviderLocationResult","data":{"allOf":[{"$ref":"#/components/schemas/BaseResult"},{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ProviderLocation"}}}]}},"components/schemas/ProviderLocationType":{"id":"components/schemas/ProviderLocationType","kind":"json-schema","title":"ProviderLocationType","data":{"type":"string","enum":["in_person_provider","virtual_provider"]}},"components/schemas/ProviderNpiResponse":{"id":"components/schemas/ProviderNpiResponse","kind":"json-schema","title":"ProviderNpiResponse","data":{"allOf":[{"$ref":"#/components/schemas/PaginatedBaseResult"},{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/ProviderNpis"}}}]}},"components/schemas/ProviderNpis":{"id":"components/schemas/ProviderNpis","kind":"json-schema","title":"ProviderNpis","data":{"type":"object","properties":{"npis":{"type":"array","items":{"type":"string"}}}}},"components/schemas/ProviderResult":{"id":"components/schemas/ProviderResult","kind":"json-schema","title":"ProviderResult","data":{"allOf":[{"$ref":"#/components/schemas/BaseResult"},{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ProvidersByNpi"}}},"description":"Data that will be returned upon a provider lookup."}]}},"components/schemas/ProviderReviewsResponse":{"id":"components/schemas/ProviderReviewsResponse","kind":"json-schema","title":"ProviderReviewsResponse","data":{"allOf":[{"$ref":"#/components/schemas/BaseResult"},{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/ProviderReviewsData"}}}]}},"components/schemas/ProviderReviewsData":{"id":"components/schemas/ProviderReviewsData","kind":"json-schema","title":"ProviderReviewsData","data":{"type":"object","required":["provider_id","total_reviews"],"properties":{"provider_id":{"type":"string","description":"The Zocdoc provider ID"},"total_reviews":{"type":"integer","description":"Total number of reviews for the provider"},"average_overall_rating":{"type":"number","format":"double","description":"The average overall rating of the provider (1-5), rounded to 1 decimal place"},"average_bedside_rating":{"type":"number","format":"double","description":"The average bedside rating of the provider (1-5), rounded to 1 decimal place"},"average_wait_time_rating":{"type":"number","format":"double","description":"The average wait time rating of the provider (1-5), rounded to 1 decimal place"}}}},"components/schemas/ProviderReviewsBatchResponse":{"id":"components/schemas/ProviderReviewsBatchResponse","kind":"json-schema","title":"ProviderReviewsBatchResponse","data":{"allOf":[{"$ref":"#/components/schemas/BaseResult"},{"type":"object","required":["data"],"properties":{"data":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One item for each distinct requested provider_id, in request order."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/ProviderReviewsData"}}}}]}},"components/schemas/ProviderSearchResult":{"id":"components/schemas/ProviderSearchResult","kind":"json-schema","title":"ProviderSearchResult","data":{"type":"object","required":["search_parameters","provider_locations"],"properties":{"search_parameters":{"$ref":"#/components/schemas/SearchParameters"},"provider_locations":{"type":"array","items":{"$ref":"#/components/schemas/ProviderLocation"}}}}},"components/schemas/ProvidersByNpi":{"id":"components/schemas/ProvidersByNpi","kind":"json-schema","title":"ProvidersByNpi","data":{"type":"object","properties":{"npi":{"type":"string"},"providers":{"type":"array","items":{"$ref":"#/components/schemas/ProviderDetails"}}}}},"components/schemas/ReferenceMetadata":{"id":"components/schemas/ReferenceMetadata","kind":"json-schema","title":"ReferenceMetadata","data":{"type":"object","properties":{"created_timestamp_utc":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date & time of when the reference data was made in ISO-8601 format with a timezone offset representing UTC"},"children":[]}]}]}],"example":"2022-04-27T09:00:00-00:00"},"last_updated_timestamp_utc":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date & time of when the reference data was last updated in ISO-8601 format with a timezone offset representing UTC"},"children":[]}]}]}],"example":"2022-04-27T09:00:00-00:00"}}}},"components/schemas/SearchParameters":{"id":"components/schemas/SearchParameters","kind":"json-schema","title":"SearchParameters","data":{"type":"object","required":["specialty_id","visit_reason_id"],"properties":{"specialty_id":{"type":"string","description":"The Zocdoc ID of the specialty used to search with. If no specialty was provided by the developer, this will be the specialty associated with the visit reason ID that was provided.","example":"sp_153"},"visit_reason_id":{"type":"string","description":"The Zocdoc ID of the visit reason used to search with. If no visit reason was provided by the developer, this will be the default visit reason for the specialty id that was provided.","example":"pc_FRO-18leckytNKtruw5dLR"}}}},"components/schemas/SharedAppointmentResponseData":{"id":"components/schemas/SharedAppointmentResponseData","kind":"json-schema","title":"SharedAppointmentResponseData","data":{"allOf":[{"$ref":"#/components/schemas/AppointmentBaseResponseData"},{"type":"object","required":["is_provider_resource","confirmation_type"],"properties":{"is_provider_resource":{"type":"boolean","description":"Whether the appointment will be performed by a professional under the supervision of the booked provider."},"location_phone_number":{"type":"string","description":"The appointment location's unformatted 10 digit phone number","example":"9999999999"},"location_phone_extension":{"type":"string","description":"The appointment location's unformatted extension number, as digits"},"waiting_room_path":{"type":"string","description":"Patient facing url that can be used to navigate to Zocdoc video service appointments"},"confirmation_type":{"$ref":"#/components/schemas/AppointmentConfirmationType"}}}]}},"components/schemas/Timeslot":{"id":"components/schemas/Timeslot","kind":"json-schema","title":"Timeslot","data":{"type":"object","required":["start_time"],"properties":{"start_time":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date & time of the appointment in ISO-8601 format with a timezone offset. The timezone offset will be the provider's local time zone."},"children":[]}]}]}],"example":"2022-04-27T09:00:00-04:00"},"visit_reason_id":{"type":"string","description":"The Zocdoc ID of the visit reason this timeslot is valid for.","example":"pc_FRO-18leckytNKtruw5dLR"},"booking_url":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Non-PHI deep link URL that allows developers to book this specific timeslot on zocdoc.com. Utm parameters (utm_medium=partnersynd and utm_source={appClientId}) will be automatically added. Developers will not be able to see the result of the booking."},"children":[]}]}]}],"example":"https://www.zocdoc.com/booking/start?startTime=638874819000000000&locationId=274383&procedureId=75&professionalId=405844"}}}},"components/schemas/VirtualLocation":{"id":"components/schemas/VirtualLocation","kind":"json-schema","title":"VirtualLocation","data":{"allOf":[{"$ref":"#/components/schemas/BaseProviderDetailsLocation"},{"$ref":"#/components/schemas/BaseVirtualLocation"}]}},"components/schemas/VisitType":{"id":"components/schemas/VisitType","kind":"json-schema","title":"VisitType","data":{"type":"string","description":"The type of patient visit with the provider.","enum":["all","in_person","video_visit"],"example":"all"}},"components/schemas/WebhookMockAppointmentData":{"id":"components/schemas/WebhookMockAppointmentData","kind":"json-schema","title":"WebhookMockAppointmentData","data":{"type":"object","required":["appointment_id","appointment_updated_timestamp","appointment_update_type"],"properties":{"appointment_id":{"type":"string"},"practice_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Zocdoc id of the practice the appointment belongs to."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional. On real webhooks the key is omitted entirely (absent, not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"unless your app client is enabled for the field and the event carries a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"practice id, so parse for a key that may be missing. This field is currently"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for select partners. If you are unsure if you have access, please contact"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zocdoc."},"children":[]}]}]}],"example":"pt_abc123-def456_wxyz7890"},"appointment_updated_timestamp":{"type":"string"},"appointment_update_type":{"$ref":"#/components/schemas/AppointmentUpdateType"},"changed_attributes":{"type":"array","items":{"$ref":"#/components/schemas/AppointmentChangedAttribute"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of changed attributes when webhook is triggered due to attribute changes. Each object must contain at least an attribute_path indicating the changed field."},"children":[]}]}]}]}}}},"components/schemas/AppointmentChangedAttribute":{"id":"components/schemas/AppointmentChangedAttribute","kind":"json-schema","title":"AppointmentChangedAttribute","data":{"type":"object","required":["attribute_path"],"properties":{"attribute_path":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The path to the changed attribute in dot notation (e.g., \"appointment.start_time\", \"patient.uploaded_attachments\")"},"children":[]}]}]}],"example":"appointment.start_time"},"attachment_type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required when attribute_path is \"patient.uploaded_attachments\", indicates the type of attachment"},"children":[]}]}]}]}}}},"components/schemas/WebhookMockDataRequest":{"id":"components/schemas/WebhookMockDataRequest","kind":"json-schema","title":"WebhookMockDataRequest","data":{"type":"object","required":["webhook_url","webhook_key"],"properties":{"webhook_url":{"type":"string","description":"a valid url to receive the mock webhook request"},"webhook_key":{"type":"string","description":"a valid key for the signature in base64 format"},"appointment_update_type":{"$ref":"#/components/schemas/AppointmentUpdateType"}}}},"components/schemas/WebhookMockRequestData":{"id":"components/schemas/WebhookMockRequestData","kind":"json-schema","title":"WebhookMockRequestData","data":{"type":"object","required":["data_type","appointment_data"],"properties":{"data_type":{"type":"string"},"appointment_data":{"$ref":"#/components/schemas/WebhookMockAppointmentData"}}}},"components/schemas/WebhookMockResponse":{"id":"components/schemas/WebhookMockResponse","kind":"json-schema","title":"WebhookMockResponse","data":{"type":"object","required":["event_type","webhook_timestamp","data"],"properties":{"event_type":{"type":"string"},"webhook_timestamp":{"type":"string"},"data":{"$ref":"#/components/schemas/WebhookMockRequestData"}}}},"components/schemas/AppointmentConfirmationType":{"id":"components/schemas/AppointmentConfirmationType","kind":"json-schema","title":"AppointmentConfirmationType","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies how the appointment confirmation will be handled."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"auto: means the system will automatically confirm."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"manual: means confirmation requires user action."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pending_evaluation: indicates that the confirmation approach is pending evaluation."},"children":[]}]}]}]}],"enum":["auto","manual","pending_evaluation"]}},"components/schemas/UploadAppointmentAttachmentRequest":{"id":"components/schemas/UploadAppointmentAttachmentRequest","kind":"json-schema","title":"UploadAppointmentAttachmentRequest","data":{"type":"object","required":["attachment","attachment_type"],"properties":{"attachment":{"type":"string","format":"binary"},"attachment_type":{"$ref":"#/components/schemas/AttachmentType"}}}},"components/schemas/UploadAppointmentAttachmentResponse":{"id":"components/schemas/UploadAppointmentAttachmentResponse","kind":"json-schema","title":"UploadAppointmentAttachmentResponse","data":{"allOf":[{"$ref":"#/components/schemas/BaseResult"},{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/UploadAppointmentAttachmentResponseData"}}}]}},"components/schemas/UploadAppointmentAttachmentResponseData":{"id":"components/schemas/UploadAppointmentAttachmentResponseData","kind":"json-schema","title":"UploadAppointmentAttachmentResponseData","data":{"type":"object","required":["appointment_id","attachments"],"properties":{"appointment_id":{"type":"string"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/UploadedAppointmentAttachment"}}}}},"components/schemas/UploadedAppointmentAttachment":{"id":"components/schemas/UploadedAppointmentAttachment","kind":"json-schema","title":"UploadedAppointmentAttachment","data":{"type":"object","required":["attachment_type"],"properties":{"attachment_type":{"$ref":"#/components/schemas/AttachmentType"}}}},"components/schemas/AttachmentType":{"id":"components/schemas/AttachmentType","kind":"json-schema","title":"AttachmentType","data":{"type":"string","enum":["community_care_packet","pcp_patient_referral","patient_front_insurance_card","patient_back_insurance_card"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of attachment being uploaded."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"community_care_packet"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Required for VA referrals to Community Care Providers. Use when submitting referral documents required by the Department  of Veterans Affairs for appointments within its extended network."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pcp_patient_referral"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Use to support appointments booked with an approved referral from a primary care doctor."},"children":[]}]}]}]}]}},"components/schemas/SchedulableEntitiesResponse":{"id":"components/schemas/SchedulableEntitiesResponse","kind":"json-schema","title":"SchedulableEntitiesResponse","data":{"allOf":[{"$ref":"#/components/schemas/PaginatedBaseResult"},{"type":"object","required":["data"],"properties":{"data":{"$ref":"#/components/schemas/SchedulableEntitiesData"}}}]}},"components/schemas/SchedulableEntitiesOverlapsRequestBody":{"id":"components/schemas/SchedulableEntitiesOverlapsRequestBody","kind":"json-schema","title":"SchedulableEntitiesOverlapsRequestBody","data":{"type":"object","required":["overlaps","developer_app_state"],"properties":{"overlaps":{"type":"array","maxItems":100,"items":{"$ref":"#/components/schemas/MatchRequestInput"}},"developer_app_state":{"$ref":"#/components/schemas/DeveloperAppStateInput"}}}},"components/schemas/MatchRequestInput":{"id":"components/schemas/MatchRequestInput","kind":"json-schema","title":"MatchRequestInput","data":{"type":"object","required":["npi"],"properties":{"npi":{"type":"string","description":"National Provider Identifier"},"metadata":{"type":"array","items":{"$ref":"#/components/schemas/MatchRequestMetadataItem"}}}}},"components/schemas/MatchRequestMetadataItem":{"id":"components/schemas/MatchRequestMetadataItem","kind":"json-schema","title":"MatchRequestMetadataItem","data":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"}}}},"components/schemas/DeveloperAppStateInput":{"id":"components/schemas/DeveloperAppStateInput","kind":"json-schema","title":"DeveloperAppStateInput","data":{"type":"string","enum":["disabled","enabled"],"description":"Whether the developer's app is enabled or disabled"}},"components/schemas/SchedulableEntitiesOverlapsResponseBody":{"id":"components/schemas/SchedulableEntitiesOverlapsResponseBody","kind":"json-schema","title":"SchedulableEntitiesOverlapsResponseBody","data":{"allOf":[{"$ref":"#/components/schemas/BaseResult"},{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MatchRequestResponseItem"}}}}]}},"components/schemas/MatchRequestResponseItem":{"id":"components/schemas/MatchRequestResponseItem","kind":"json-schema","title":"MatchRequestResponseItem","data":{"type":"object","required":["npi","schedule_state","schedulable_entities"],"properties":{"npi":{"type":"string","description":"National Provider Identifier"},"schedule_state":{"$ref":"#/components/schemas/ZocdocSchedulableStatus"},"schedulable_entities":{"type":"array","items":{"$ref":"#/components/schemas/OverlapsSchedulableEntityItem"}}}}},"components/schemas/ZocdocSchedulableStatus":{"id":"components/schemas/ZocdocSchedulableStatus","kind":"json-schema","title":"ZocdocSchedulableStatus","data":{"type":"string","enum":["schedulable","not_schedulable","added_to_queue"]}},"components/schemas/OverlapsSchedulableEntityItem":{"id":"components/schemas/OverlapsSchedulableEntityItem","kind":"json-schema","title":"OverlapsSchedulableEntityItem","data":{"type":"object","required":["id","entity_type"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zocdoc provider location ID (e.g., pr_zzzz|lo_yyyy)"},"children":[]}]}]}]},"entity_type":{"$ref":"#/components/schemas/OverlapsSchedulableEntityType"}}}},"components/schemas/OverlapsSchedulableEntityType":{"id":"components/schemas/OverlapsSchedulableEntityType","kind":"json-schema","title":"OverlapsSchedulableEntityType","data":{"type":"string","description":"Entity type","enum":["provider_location"]}},"components/schemas/AppointmentStatusToSet":{"id":"components/schemas/AppointmentStatusToSet","kind":"json-schema","title":"AppointmentStatusToSet","data":{"type":"string","enum":["arrived","no_show"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New status to set for the appointment. Accepted values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"arrived"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Patient has arrived at the office."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"no_show"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Patient did not show up for their appointment."},"children":[]}]}]}]}]}},"components/schemas/ExternalUpdateAppointmentStatusRequestBody":{"id":"components/schemas/ExternalUpdateAppointmentStatusRequestBody","kind":"json-schema","title":"ExternalUpdateAppointmentStatusRequestBody","data":{"type":"object","required":["appointment_id","appointment_status"],"properties":{"appointment_id":{"type":"string","description":"The Zocdoc ID of the appointment.","example":"d04b049a-41b1-4aba-9268-d8973cf72cdd"},"appointment_status":{"$ref":"#/components/schemas/AppointmentStatusToSet"}}}},"components/schemas/SchedulableEntitiesData":{"id":"components/schemas/SchedulableEntitiesData","kind":"json-schema","title":"SchedulableEntitiesData","data":{"type":"object","required":["recent_change_summary","schedulable_entities"],"properties":{"recent_change_summary":{"$ref":"#/components/schemas/RecentChangeSummary"},"schedulable_entities":{"type":"array","items":{"$ref":"#/components/schemas/SchedulableEntity"}}}}},"components/schemas/RecentChangeSummary":{"id":"components/schemas/RecentChangeSummary","kind":"json-schema","title":"RecentChangeSummary","data":{"type":"object","required":["schedulable_entities_added","schedulable_entities_removed","schedulable_entities_profile_updated"],"properties":{"schedulable_entities_added":{"type":"array","items":{"type":"string"},"description":"A provider location was activated"},"schedulable_entities_removed":{"type":"array","items":{"type":"string"},"description":"A provider location was deactivated"},"schedulable_entities_profile_updated":{"type":"array","items":{"type":"string"},"description":"provider or location profile data changed (NPI, name, specialty, address, default visit reason)"}}}},"components/schemas/SchedulableEntityType":{"id":"components/schemas/SchedulableEntityType","kind":"json-schema","title":"SchedulableEntityType","data":{"type":"string","enum":["provider_location"]}},"components/schemas/AvailabilityStatus":{"id":"components/schemas/AvailabilityStatus","kind":"json-schema","title":"AvailabilityStatus","data":{"type":"string","enum":["none","limited","available"],"description":"The availability status of the schedulable entity for the next 28 days. Limited availablility means that the entity has less than 20 timeslots available for the next 28 days."}},"components/schemas/SchedulableEntity":{"id":"components/schemas/SchedulableEntity","kind":"json-schema","title":"SchedulableEntity","data":{"type":"object","required":["id","type","go_live_timestamp_utc","profile_last_modified_timestamp_utc","new_patient_availability","existing_patient_availability"],"properties":{"id":{"type":"string"},"npi":{"type":"string"},"type":{"$ref":"#/components/schemas/SchedulableEntityType"},"go_live_timestamp_utc":{"type":"string","format":"date-time","description":"The timestamp when the schedulable entity became available in the developer's directory."},"profile_last_modified_timestamp_utc":{"type":"string","format":"date-time","description":"The timestamp when the schedulable entity's profile was last modified in the developer's directory. This includes basic information on the provider and location records."},"new_patient_availability":{"$ref":"#/components/schemas/AvailabilityInfo"},"existing_patient_availability":{"$ref":"#/components/schemas/AvailabilityInfo"},"time_zone":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IANA time zone identifier for the location, e.g., America/New_York."},"children":[]}]}]}],"example":"America/New_York"},"main_specialty_id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Zocdoc specialty ID of the provider's main specialty (format "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sp_<id>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Omitted when the provider has no main specialty."},"children":[]}]}]}],"example":"sp_123"},"main_specialty_name":{"type":"string","description":"Display name of the provider's main specialty. Omitted when the specialty id is absent or cannot be resolved.","example":"Cardiologist"}}}},"components/schemas/AvailabilityInfo":{"id":"components/schemas/AvailabilityInfo","kind":"json-schema","title":"AvailabilityInfo","data":{"type":"object","required":["next_28_days","url"],"properties":{"next_available_utc":{"type":"string","format":"date-time","description":"The next available date and time in UTC, across all visit reasons, up to 90 days in the future."},"next_28_days":{"$ref":"#/components/schemas/AvailabilityStatus"},"url":{"type":"string","description":"The GET URL to receive the schedulable entity's availability in this API for their default visit reason and the corresponding patient type."}}}},"components/schemas/PublishedContext":{"id":"components/schemas/PublishedContext","kind":"json-schema","title":"PublishedContext","data":{"type":"string","enum":["direct_listing","condition_driven_search"]}},"components/schemas/BaseResult":{"id":"components/schemas/BaseResult","kind":"json-schema","title":"BaseResult","data":{"required":["request_id"],"type":"object","properties":{"request_id":{"type":"string","description":"Unique request identifier for tracing"}}}},"components/schemas/ErrorType":{"id":"components/schemas/ErrorType","kind":"json-schema","title":"ErrorType","data":{"type":"string","enum":["api_error","invalid_request"]}},"components/schemas/Error":{"id":"components/schemas/Error","kind":"json-schema","title":"Error","data":{"required":["message"],"type":"object","properties":{"field":{"type":"string"},"message":{"type":"string"}}}},"components/schemas/ErrorResult":{"id":"components/schemas/ErrorResult","kind":"json-schema","title":"ErrorResult","data":{"allOf":[{"$ref":"#/components/schemas/BaseResult"},{"type":"object","required":["error_type","errors"],"properties":{"error_type":{"$ref":"#/components/schemas/ErrorType"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}]}},"components/schemas/PatientType":{"id":"components/schemas/PatientType","kind":"json-schema","title":"PatientType","data":{"type":"string","description":"Whether or not the patient has been to the provider's practice.","enum":["existing","new"],"example":"new"}},"components/schemas/AppointmentStatus":{"id":"components/schemas/AppointmentStatus","kind":"json-schema","title":"AppointmentStatus","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The status of the appointment. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/guides/glossary"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Appointment Status definitions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["pending_booking","confirmed","booking_failed","cancelled","no_show","pending_reschedule","rescheduled","reschedule_failed"]}},"components/schemas/PatientSex":{"id":"components/schemas/PatientSex","kind":"json-schema","title":"PatientSex","data":{"type":"string","description":"The patient's sex assigned at birth.","enum":["male","female"]}},"components/schemas/Gender":{"id":"components/schemas/Gender","kind":"json-schema","title":"Gender","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Patient's gender values"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Female at birth - Assigned female at birth"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Male at birth - Assigned male at birth"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cisgender - A person whose current gender corresponds to the sex they were assigned at birth"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Genderfluid - A person who does not identify with a fixed gender"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Genderqueer - A person who does not follow binary gender norms"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Intersex - A person born with traits, including genital anatomy, reproductive organs, hormone function, and/or chromosome patterns that may not fit the typical definition of male or female"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Non-binary - Umbrella term for a person whose gender identity lies outside the gender binary"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transgender man - A person whose gender is male and whose sex assigned at birth was female"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Transgender woman - A person whose gender is female and whose sex assigned at birth was male"},"children":[]}]}]}]}],"enum":["female_at_birth","male_at_birth","cisgender","genderfluid","genderqueer","intersex","non_binary","transgender_man","transgender_woman","prefer_not_to_say","none_apply"]}},"components/schemas/UploadedAttachmentType":{"id":"components/schemas/UploadedAttachmentType","kind":"json-schema","title":"UploadedAttachmentType","data":{"type":"string","enum":["insurance_card_medical","insurance_card_dental","insurance_card_vision","insurance_card_secondary","id_card","intake_form","community_care_packet","pcp_patient_referral","other"],"description":"Types of attachments that patients have uploaded and are returned in participant data."}},"components/schemas/RescheduleAppointmentRequestBody":{"id":"components/schemas/RescheduleAppointmentRequestBody","kind":"json-schema","title":"RescheduleAppointmentRequestBody","data":{"type":"object","required":["appointment_id","start_time"],"properties":{"appointment_id":{"type":"string","description":"The Zocdoc id of the appointment","example":"63f995c2-49c4-40c8-a93a-140fb32e913b"},"start_time":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date & time of the appointment in ISO-8601 format with a timezone offset"},"children":[]}]}]}],"example":"2022-04-27T09:00:00-04:00"}}}},"components/schemas/IteratedBaseResult":{"id":"components/schemas/IteratedBaseResult","kind":"json-schema","title":"IteratedBaseResult","data":{"allOf":[{"$ref":"#/components/schemas/BaseResult"},{"type":"object","properties":{"limit":{"type":"integer","description":"Maximum number of items requested.\nNote: For DynamoDB-style pagination, this may not match the number of items returned.\n"},"next_page_token":{"type":"string","description":"Opaque cursor token for the next page. Null if no more pages."},"next_url":{"type":"string","description":"Complete URL for fetching the next page (convenience field)"}}}]}},"components/schemas/CalendarIntegrationTimeslotWeb":{"id":"components/schemas/CalendarIntegrationTimeslotWeb","kind":"json-schema","title":"CalendarIntegrationTimeslotWeb","data":{"description":"A bookable appointment start time for a particular provider","type":"object","required":["timeslot_id","created_utc"],"properties":{"provider_id":{"type":"string","description":"Provider id","example":"pr_abc123-def456_wxyz7890"},"location_id":{"type":"string","description":"Location id","example":"lo_abc123-def456_wxyz7890"},"start_time":{"type":"string","format":"date-time-local","description":"The local date and time within the timezone. The seconds may be omitted.","example":"2024-09-03T09:30:00"},"time_zone":{"type":"string","description":"The IANA time zone id of the timeslot's start time.","example":"America/New_York"},"allowed_visit_reason_ids":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Restrict the timeslot to these visit reasons. Both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and an empty array will not restrict the timeslot."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can work in conjunction with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"excluded_visit_reason_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"allowed_visit_reason_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are superceded by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"excluded_visit_reason_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"So if a visit reason is included in both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"allowed_visit_reason_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"excluded_visit_reason_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the net effect is that visit reason"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"being excluded."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"allowed"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"excluded"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"=> Result"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"null"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"null"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all visit reasons allowed"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[A,B]"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"null"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"only A & B are allowed"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"null"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[A,B]"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all visit reasons except A & B are allowed"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[A,B]"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[B,C]"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"only A is allowed (C is irrelevant)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[A,B]"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[A,B]"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No visit reasons allowed, unbookable timeslot"},"children":[]}]}]}]}]}]}],"items":{"type":"string"},"example":["pc_FRO-18leckytNKtruw5dLR"]},"excluded_visit_reason_ids":{"type":"array","items":{"type":"string"},"example":["pc_TlZW-r06U0W3pCsIGtSI5B"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exclude these visit reasons. Both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and an empty array means no visit reasons will be excluded."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can work in conjunction with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"allowed_visit_reason_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"allowed_visit_reason_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are superceded by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"excluded_visit_reason_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"So if a visit reason is included in both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"allowed_visit_reason_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"excluded_visit_reason_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the net effect is that visit reason"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"being excluded."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"allowed"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"excluded"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"=> Result"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"null"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"null"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all visit reasons allowed"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[A,B]"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"null"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"only A & B are allowed"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"null"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[A,B]"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all visit reasons except A & B are allowed"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[A,B]"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[B,C]"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"only A is allowed (C is irrelevant)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[A,B]"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[A,B]"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No visit reasons allowed, unbookable timeslot"},"children":[]}]}]}]}]}]}]},"patient_type":{"$ref":"#/components/schemas/PatientType"},"timeslot_id":{"type":"string","description":"Timeslot id","example":"slot:ab123"},"created_utc":{"type":"string","format":"instant","description":"the time this timeslot was created in Zocdoc's system.","example":"2024-01-01T09:30:00Z"}}}},"components/schemas/TimeslotListResponse":{"id":"components/schemas/TimeslotListResponse","kind":"json-schema","title":"TimeslotListResponse","data":{"allOf":[{"$ref":"#/components/schemas/IteratedBaseResult"},{"type":"object","description":"A list of timeslots.","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CalendarIntegrationTimeslotWeb"}}}}]}},"components/schemas/TimeslotBaseRequest":{"id":"components/schemas/TimeslotBaseRequest","kind":"json-schema","title":"TimeslotBaseRequest","data":{"description":"a bookable appointment start time for a particular provider","type":"object","required":["provider_id","start_time","location_id","time_zone"],"properties":{"provider_id":{"type":"string","description":"Provider id","example":"pr_abc123-def456_wxyz7890"},"location_id":{"type":"string","description":"Location id","example":"lo_abc123-def456_wxyz7890"},"start_time":{"type":"string","format":"date-time-local","description":"the local date and time within the timezone. The seconds may be omitted.","example":"2024-10-16T09:30:00"},"time_zone":{"type":"string","description":"The IANA time zone id of the appointment. Must be valid.","example":"America/New_York"},"allowed_visit_reason_ids":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Restrict the timeslot to these visit reasons. Both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and an empty array will not restrict the timeslot."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can work in conjunction with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"excluded_visit_reason_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"allowed_visit_reason_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are superceded by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"excluded_visit_reason_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"So if a visit reason is included in both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"allowed_visit_reason_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"excluded_visit_reason_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the net effect is that visit reason"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"being excluded."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"allowed"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"excluded"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"=> Result"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"null"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"null"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all visit reasons allowed"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[A,B]"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"null"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"only A & B are allowed"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"null"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[A,B]"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all visit reasons except A & B are allowed"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[A,B]"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[B,C]"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"only A is allowed (C is irrelevant)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[A,B]"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[A,B]"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No visit reasons allowed, unbookable timeslot"},"children":[]}]}]}]}]}]}],"items":{"type":"string"},"example":["pc_TlZW-r06U0W3pCsIGtSI5B"]},"excluded_visit_reason_ids":{"type":"array","items":{"type":"string"},"example":["pc_TAZW-r16U0B3pZeIutSI3L"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exclude these visit reasons. Both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and an empty array means no visit reasons will be excluded."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can work in conjunction with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"allowed_visit_reason_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"allowed_visit_reason_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are superceded by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"excluded_visit_reason_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"So if a visit reason is included in both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"allowed_visit_reason_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"excluded_visit_reason_ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the net effect is that visit reason"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"being excluded."},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"allowed"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"excluded"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"=> Result"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"null"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"null"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all visit reasons allowed"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[A,B]"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"null"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"only A & B are allowed"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"null"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[A,B]"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all visit reasons except A & B are allowed"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[A,B]"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[B,C]"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"only A is allowed (C is irrelevant)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[A,B]"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[A,B]"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"No visit reasons allowed, unbookable timeslot"},"children":[]}]}]}]}]}]}]},"patient_type":{"$ref":"#/components/schemas/PatientType"}}}},"components/schemas/TimeslotPutRequest":{"id":"components/schemas/TimeslotPutRequest","kind":"json-schema","title":"TimeslotPutRequest","data":{"required":["timeslots"],"type":"object","properties":{"timeslots":{"type":"array","minItems":0,"maxItems":1500,"items":{"$ref":"#/components/schemas/TimeslotBaseRequest"}}}}},"components/schemas/TimeslotPutErrors":{"id":"components/schemas/TimeslotPutErrors","kind":"json-schema","title":"TimeslotPutErrors","data":{"type":"object","required":["not_found_location_ids"],"properties":{"not_found_location_ids":{"type":"array","items":{"type":"string"},"description":"Location IDs that were not found on the Zocdoc side."}}}},"components/schemas/TimeslotPutResponse":{"id":"components/schemas/TimeslotPutResponse","kind":"json-schema","title":"TimeslotPutResponse","data":{"type":"object","properties":{"errors":{"$ref":"#/components/schemas/TimeslotPutErrors"}}}},"schema_38":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_38"},"schema_39":{"kind":"json-schema","data":{"type":"integer","minimum":1,"maximum":10000},"id":"schema_39"},"schema_40":{"kind":"json-schema","data":{"type":"string"},"id":"schema_40"},"schema_41":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_41"},"schema_42":{"kind":"json-schema","data":{"type":"integer","minimum":0,"maximum":200},"id":"schema_42"},"schema_43":{"kind":"json-schema","data":{"type":"integer","minimum":1,"maximum":500},"id":"schema_43"},"schema_44":{"kind":"json-schema","data":{"$ref":"#/components/schemas/InsuranceStatus"},"id":"schema_44"},"schema_45":{"kind":"json-schema","data":{"type":"string","example":"NY"},"id":"schema_45"},"schema_46":{"kind":"json-schema","data":{"$ref":"#/components/schemas/InsuranceNetworkType"},"id":"schema_46"},"schema_47":{"kind":"json-schema","data":{"$ref":"#/components/schemas/InsuranceProgramType"},"id":"schema_47"},"schema_48":{"kind":"json-schema","data":{"$ref":"#/components/schemas/CareCategory"},"id":"schema_48"},"schema_49":{"kind":"json-schema","data":{"type":"string","example":"ip_31820"},"id":"schema_49"},"schema_50":{"kind":"json-schema","data":{"type":"string","example":"1234567891,0123456789"},"id":"schema_50"},"schema_51":{"kind":"json-schema","data":{"type":"number","format":"float","minimum":-90,"maximum":90},"id":"schema_51"},"schema_52":{"kind":"json-schema","data":{"type":"number","format":"float","minimum":-180,"maximum":180},"id":"schema_52"},"schema_53":{"kind":"json-schema","data":{"type":"string","example":36925},"id":"schema_53"},"schema_54":{"kind":"json-schema","data":{"type":"string","example":"sp_153"},"id":"schema_54"},"schema_55":{"kind":"json-schema","data":{"type":"string","example":"pc_FRO-18leckytNKtruw5dLR"},"id":"schema_55"},"schema_56":{"kind":"json-schema","data":{"$ref":"#/components/schemas/VisitType"},"id":"schema_56"},"schema_57":{"kind":"json-schema","data":{"type":"integer","minimum":1,"maximum":50},"id":"schema_57"},"schema_58":{"kind":"json-schema","data":{"type":"string","example":"pr_abc123-def456_wxyz7890|lo_abc123-def456_wxyz7890"},"id":"schema_58"},"schema_59":{"kind":"json-schema","data":{"type":"string","example":"pr_abc123-def456_wxyz7890|lo_abc123-def456_wxyz7890,pr_ghi123-jkl456_mnop7890|lo_ghi123-jkl456_mnop7890"},"id":"schema_59"},"schema_60":{"kind":"json-schema","data":{"$ref":"#/components/schemas/PatientType"},"id":"schema_60"},"schema_61":{"kind":"json-schema","data":{"type":"string","format":"date"},"id":"schema_61"},"schema_62":{"kind":"json-schema","data":{"$ref":"#/components/schemas/PublishedContext"},"id":"schema_62"},"schema_63":{"kind":"json-schema","data":{"type":"string","example":"pr_xyz123,pr_abc456"},"id":"schema_63"},"schema_64":{"kind":"json-schema","data":{"$ref":"#/components/schemas/BuildingType"},"id":"schema_64"},"schema_65":{"kind":"json-schema","data":{"type":"string","example":"d04b049a-41b1-4aba-9268-d8973cf72cdd"},"id":"schema_65"},"schema_66":{"kind":"json-schema","data":{"type":"string","example":"pr_abc123-def456_wxyz7890"},"id":"schema_66"},"schema_67":{"kind":"json-schema","data":{"type":"string","format":"date","example":"2024-10-26"},"id":"schema_67"},"schema_68":{"kind":"json-schema","data":{"type":"string","format":"date","example":"2024-10-16"},"id":"schema_68"},"schema_69":{"kind":"json-schema","data":{"type":"string","example":"pending_booking,confirmed"},"id":"schema_69"},"schema_70":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AppointmentSortByType"},"id":"schema_70"},"schema_71":{"kind":"json-schema","data":{"$ref":"#/components/schemas/AppointmentSortDirectionType"},"id":"schema_71"},"schema_72":{"kind":"json-schema","data":{"type":"string","example":"pt_abc123-def456_wxyz7890,pt_ghi123-jkl456_mnop7890"},"id":"schema_72"},"schema_73":{"kind":"json-schema","data":{"type":"string","example":"pr_abc123-def456_wxyz7890,pr_ghi123-jkl456_mnop7890"},"id":"schema_73"},"schema_74":{"kind":"json-schema","data":{"type":"string","example":"lo_abc123-def456_wxyz7890,lo_ghi123-jkl456_mnop7890"},"id":"schema_74"},"schema_75":{"kind":"json-schema","data":{"type":"string","format":"instant","example":"2024-01-01 00:00:00+00:00"},"id":"schema_75"}},"exampleStore":{},"securitySchemeStore":{"ClientCredentialsFlow":{"id":"ClientCredentialsFlow","type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Machine to machine authentication (for use from client server to Zocdoc)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com/oauth/token"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com/oauth/token"},"children":[]}]}]}],"flows":{"clientCredentials":{"tokenUrl":"https://auth.zocdoc.com/oauth/token","scopes":{"external.credential.rotate":"Rotate the authenticated client secret.","external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.anonymous_token.write":"Create anonymous tokens used for discovery endpoints.","external.provider_insurance.write":"Update the insurance accepted by a provider.","external.schedulable_entity.read":"Read schedulable entities.","external.booking_intent.write":"Create and modify booking intents.","external.booking_intent.read":"Read booking intents.","external.provider.read":"Read provider details, and read and revoke your partner-connect consent grants."}}}},"AuthorizationCodeFlow":{"id":"AuthorizationCodeFlow","type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Log in as a user. Client Secret is not necessary for this login flow."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Production: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth.zocdoc.com"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sandbox: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://auth-api-developer-sandbox.zocdoc.com"},"children":[]}]}]}],"flows":{"authorizationCode":{"x-usePkce":true,"tokenUrl":"https://auth.zocdoc.com/oauth/token","authorizationUrl":"https://auth.zocdoc.com/authorize","scopes":{"external.appointment.write":"Book and modify appointments.","external.appointment.read":"Read basic details of your appointments.","external.schedulable_entity.read":"Read schedulable entities."}}}}},"servers":[{"url":"https://api-developer-sandbox.zocdoc.com","description":"Sandbox"},{"url":"https://api-developer.zocdoc.com","description":"Production"}]},"options":{"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/index.json?download"},{"url":"/_bundle/apis/index.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"API Documentation"}},"baseSlug":"/apis","routesMapping":{}}