### Getting started Source: https://docs.nexhealth.com/v20240412/edit/webhooks Provides essential information for users new to the NexHealth API, guiding them through initial setup and basic concepts. ```APIDOC ## GET /api/getting-started ### Description This endpoint provides introductory information and guides for new users of the NexHealth API. ### Method GET ### Endpoint /api/getting-started ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **content** (string) - Introductory documentation content. #### Response Example ```json { "content": "Welcome to the NexHealth API! This section guides you through the initial steps..." } ``` ``` -------------------------------- ### Getting Started API Source: https://docs.nexhealth.com/v20240412/edit/troubleshooting-installs Basic information and getting started guide for the NexHealth API. ```APIDOC ## GET /api/getting-started ### Description Provides introductory information and guides for getting started with the NexHealth API. ### Method GET ### Endpoint /api/getting-started ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **message** (string) - A welcome message or introductory text. #### Response Example { "message": "Welcome to the NexHealth API!" } ``` -------------------------------- ### NexHealth API: Getting Started Example Source: https://docs.nexhealth.com/edit/institutions-and-locations A basic 'Getting started' example for the NexHealth API. This demonstrates a typical GET request and its expected JSON response structure, suitable for initial integration. ```json { "api": { "method": "get", "url": "", "auth": "required", "results": { "codes": [ { "name": "", "code": "{}", "language": "json", "status": 200 }, { "name": "", "code": "{}", "language": "json", "status": 400 } ] }, "params": [], "examples": { "codes": [] } }, "title": "Getting started", "type": "basic", "slug": "getting-started" } ``` -------------------------------- ### Getting Started Source: https://docs.nexhealth.com/v20240412/edit/nexhealth-synchronizer-installation-guide Information on how to get started with the NexHealth API, including setup and basic usage. ```APIDOC ## GET /api/getting-started ### Description Provides introductory information and setup guides for the NexHealth API. ### Method GET ### Endpoint /api/getting-started ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **content** (object) - Contains introductory API information. #### Response Example { "content": "..." } ``` -------------------------------- ### Get Started with Postman API Source: https://docs.nexhealth.com/v20240412/edit/nexhealth-synchronizer-installation-guide This endpoint guides users on how to get started with Postman, likely for testing or interacting with the NexHealth API. It may include setup instructions or example requests. ```APIDOC ## GET /websites/nexhealth/working-with-postman ### Description Provides guidance on using Postman to interact with the NexHealth API. ### Method GET ### Endpoint /websites/nexhealth/working-with-postman ### Parameters No parameters are specified for this endpoint. ### Request Example ```json { "example": "No request body needed" } ``` ### Response #### Success Response (200) - **instructions** (string) - Steps or information for using Postman. - **example_request** (object) - An example request to send via Postman. #### Response Example ```json { "instructions": "Follow these steps to set up Postman...", "example_request": {} } ``` ``` -------------------------------- ### Getting Started Source: https://docs.nexhealth.com/edit/glossary Information on how to get started with the NexHealth API, including basic setup and authentication. ```APIDOC ## Getting Started ### Description Provides introductory information and setup steps for using the NexHealth API. ### Method GET ### Endpoint /api/getting-started ### Parameters None ### Request Example (No request body for this endpoint) ### Response #### Success Response (200) - **message** (string) - A welcome message or introductory text. #### Response Example ```json { "message": "Welcome to the NexHealth API!" } ``` ``` -------------------------------- ### NexHealth Synchronizer Installation Guide Overview Source: https://docs.nexhealth.com/v20240412/discuss/68cd3c3469cafaaf079a7b68 This entry represents the NexHealth synchronizer installation guide. It outlines the API method (GET) and authentication requirements. No specific code examples are provided in this overview, but it indicates the structure for API interactions and general setup. ```text Title: NexHealth synchronizer installation guide API Method: GET Authentication: Required Parameters: [] ``` -------------------------------- ### Getting Started Source: https://docs.nexhealth.com/edit/using-the-nexhealth-developer-portal This section provides introductory information for getting started with the NexHealth Developer Portal. It includes details on initial setup and basic API interactions. ```APIDOC ## GET /api/getting-started ### Description Provides introductory information for getting started with the NexHealth Developer Portal. ### Method GET ### Endpoint /api/getting-started ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **data** (object) - Contains introductory information. #### Response Example ```json { "data": {} } ``` ``` -------------------------------- ### Getting Started Source: https://docs.nexhealth.com/v20240412/discuss/68beb1f3f52782b7f105c679 This section provides basic information on how to get started with the NexHealth API. It includes details on authentication and initial setup. ```APIDOC ## GET /api/getting-started ### Description Provides introductory information for using the NexHealth API. ### Method GET ### Endpoint /api/getting-started ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **data** (object) - Contains introductory API information. #### Response Example ```json { "data": {} } ``` ``` -------------------------------- ### Getting Started Source: https://docs.nexhealth.com/v20240412/edit/book-an-appointment Information on how to get started with the NexHealth API, including basic setup and conceptual overview. ```APIDOC ## GET /api/getting-started ### Description Provides introductory information and guides for users new to the NexHealth API. ### Method GET ### Endpoint /api/getting-started ### Parameters None ### Request Example None ### Response #### Success Response (200) - **content** (string) - Markdown content with getting started information. #### Response Example ```json { "content": "# Getting Started with NexHealth API\n\nWelcome to the NexHealth API! This guide will walk you through the initial steps..." } ``` ``` -------------------------------- ### Getting started API Source: https://docs.nexhealth.com/v20240412/edit/using-the-nexhealth-developer-portal This section provides introductory information and examples for getting started with the NexHealth API. ```APIDOC ## GET /api/getting-started ### Description Provides introductory information for the NexHealth API. ### Method GET ### Endpoint /api/getting-started ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **message** (string) - A welcome message or introductory text. #### Response Example { "message": "Welcome to the NexHealth API!" } ``` -------------------------------- ### Getting Started API Source: https://docs.nexhealth.com/edit/getting-started This section describes the 'Getting Started' page, which typically provides an overview of the API and initial setup instructions. It includes information on the API method, authentication, and expected response codes. ```APIDOC ## GET / ### Description This endpoint likely serves as the entry point for the API or a general information endpoint. It's usually used to retrieve basic information or documentation. ### Method GET ### Endpoint / ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```json { "example": "No request body for GET" } ``` ### Response #### Success Response (200) - **(object)** - General API information or documentation details. #### Response Example ```json { "message": "Welcome to the NexHealth API!", "version": "1.0.0" } ``` ``` -------------------------------- ### NexHealth API - Getting Started Source: https://docs.nexhealth.com/edit/troubleshooting-installs This endpoint provides basic information for getting started with the NexHealth API. It outlines initial setup and access requirements. ```APIDOC ## GET /api/getting-started ### Description Provides basic information for getting started with the NexHealth API. ### Method GET ### Endpoint /api/getting-started ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```json {} ``` ### Response #### Success Response (200) - **data** (object) - Contains general information for getting started. #### Response Example ```json { "data": {} } ``` ``` -------------------------------- ### GET /nexhealth-synchronizer-installation-guide Source: https://docs.nexhealth.com/edit/access-procedure-codes Provides the installation guide for the NexHealth synchronizer, including prerequisites and setup instructions. ```APIDOC ## GET /nexhealth-synchronizer-installation-guide ### Description This endpoint provides the official installation guide for the NexHealth synchronizer. It includes prerequisites, configuration steps, and troubleshooting tips. ### Method GET ### Endpoint /nexhealth-synchronizer-installation-guide ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **installation_guide** (string) - The content of the synchronizer installation guide. #### Response Example ```json { "installation_guide": "## NexHealth Synchronizer Installation Guide\n1. Prerequisites:\n - ...\n2. Installation Steps:\n - ..." } ``` ``` -------------------------------- ### Getting Started API Source: https://docs.nexhealth.com/discuss_sorting=recent Provides initial information for getting started with the NexHealth API, including authentication and basic setup. ```APIDOC ## GET /api/getting-started ### Description Retrieves introductory information and setup instructions for the NexHealth API. ### Method GET ### Endpoint /api/getting-started ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **message** (string) - A success message or introductory text. - **setup_guide** (object) - Details on how to set up and authenticate. #### Response Example ```json { "message": "Welcome to the NexHealth API!", "setup_guide": { "authentication": "API Key required", "endpoints": "See documentation for available endpoints" } } ``` ``` -------------------------------- ### GET /api/synchronizer/installation-guide Source: https://docs.nexhealth.com/edit/whats-possible-with-the-nexhealth-api Provides the installation guide for the NexHealth synchronizer. ```APIDOC ## GET /api/synchronizer/installation-guide ### Description This endpoint provides the official installation guide for the NexHealth synchronizer. ### Method GET ### Endpoint /api/synchronizer/installation-guide ### Parameters #### Query Parameters None ### Request Example None ### Response #### Success Response (200) - **guide** (string) - The detailed installation guide for the NexHealth synchronizer. #### Response Example ```json { "installation_steps": "1. Download the synchronizer... 2. Configure settings..." } ``` ``` -------------------------------- ### Getting Started API Source: https://docs.nexhealth.com/v20240412/edit/institutions-syncs-and-locations Provides introductory information and setup guidance for the NexHealth API. ```APIDOC ## GET /websites/nexhealth/getting-started ### Description This endpoint provides introductory information and setup guidance for the NexHealth API. ### Method GET ### Endpoint /websites/nexhealth/getting-started ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **data** (object) - Contains introductory information. #### Response Example ```json { "data": { "title": "Getting started", "description": "Learn how to get started with the NexHealth API.", "setup_steps": [ "Register for an API key.", "Configure your application.", "Make your first API call." ] } } ``` ``` -------------------------------- ### Getting Started API Source: https://docs.nexhealth.com/v20240412/edit/interpreting-sync-status This section provides basic information on getting started with the NexHealth API. It includes details about authentication and initial setup. ```APIDOC ## GET /api/getting-started ### Description Provides introductory information and setup guides for the NexHealth API. ### Method GET ### Endpoint /api/getting-started ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **message** (string) - A welcome message and introductory instructions. #### Response Example ```json { "message": "Welcome to the NexHealth API! Follow our guides to get started." } ``` ``` -------------------------------- ### Getting Started API Source: https://docs.nexhealth.com/discuss This endpoint provides basic information for getting started with the NexHealth API. It includes details on authentication and initial setup. ```APIDOC ## GET /api/getting-started ### Description Provides essential information for new users to begin integrating with the NexHealth API. ### Method GET ### Endpoint /api/getting-started ### Parameters #### Query Parameters None #### Path Parameters None ### Request Body None ### Request Example None ### Response #### Success Response (200) - **message** (string) - A welcome message and instructions. - **authentication_required** (boolean) - Indicates if authentication is needed. #### Response Example ```json { "message": "Welcome to the NexHealth API. Please refer to our authentication guide before making requests.", "authentication_required": true } ``` #### Error Response (400) - **error** (string) - Description of the error. #### Response Example ```json { "error": "Bad request: Missing authentication token." } ``` ``` -------------------------------- ### Getting Started API Source: https://docs.nexhealth.com/v20240412/discuss This endpoint provides introductory information for getting started with the NexHealth API. It outlines the basic requirements and initial setup. ```APIDOC ## GET /api/getting-started ### Description Provides introductory information for getting started with the NexHealth API. ### Method GET ### Endpoint /api/getting-started ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **status** (string) - Indicates the success of the request. - **data** (object) - Contains the getting started information. #### Response Example ```json { "status": "success", "data": { "message": "Welcome to the NexHealth API. Please refer to the documentation for usage." } } ``` #### Error Response (400) - **status** (string) - Indicates an error occurred. - **error** (string) - Describes the error. #### Response Example ```json { "status": "error", "error": "Invalid request parameters." } ``` ``` -------------------------------- ### Getting Started API Source: https://docs.nexhealth.com/v20240412/discuss_sorting=open This section details the 'Getting Started' API endpoint, which is a basic endpoint for initial setup and information retrieval. It requires authentication and provides sample JSON responses for success and error cases. ```APIDOC ## GET / ### Description This is a basic endpoint for getting started with the NexHealth API. It requires authentication and returns general information. ### Method GET ### Endpoint / ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```json {} ``` ### Response #### Success Response (200) - **response** (object) - General information object. #### Response Example ```json { "message": "Welcome to the NexHealth API!" } ``` #### Error Response (400) - **error** (object) - Error object indicating a bad request. #### Error Response Example ```json { "error": "Invalid request" } ``` ``` -------------------------------- ### GET /nexhealth-synchronizer-installation-guide Source: https://docs.nexhealth.com/edit/webhooks Provides the installation guide for the NexHealth synchronizer. Includes authentication details and possible response codes. ```APIDOC ## GET /nexhealth-synchronizer-installation-guide ### Description Provides the installation guide for the NexHealth synchronizer. ### Method GET ### Endpoint /nexhealth-synchronizer-installation-guide ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **response body** (object) - Contains details of the installation guide. #### Response Example ```json {} ``` #### Error Response (400) - **response body** (object) - An object indicating an error occurred. #### Response Example ```json {} ``` ``` -------------------------------- ### Get started with Postman API Source: https://docs.nexhealth.com/edit/setting-up-an-open-dental-test-server Documentation for the 'Get started with Postman' page, detailing API interactions for Postman setup. ```APIDOC ## GET working-with-postman ### Description This endpoint provides information on how to get started with Postman for API interactions. ### Method GET ### Endpoint (Endpoint not specified in the provided text, likely depends on context) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **API Response** (json) - Details of the API interaction. #### Response Example ```json {} ``` ``` -------------------------------- ### Get started with scheduling API Source: https://docs.nexhealth.com/v20240412/edit/webhooks This endpoint guides users on how to get started with the scheduling features of the platform. ```APIDOC ## GET /websites/nexhealth/book-an-appointment ### Description Get started with the scheduling features, including booking appointments. ### Method GET ### Endpoint /websites/nexhealth/book-an-appointment ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **(object)** - Information and steps for using the scheduling system. #### Response Example ```json {} ``` ``` -------------------------------- ### GET /nexhealth-synchronizer-installation-guide-1 Source: https://docs.nexhealth.com/v20240412/discuss/68d661c305391a8977a1f0d5 Provides the installation guide for the NexHealth synchronizer. ```APIDOC ## GET /nexhealth-synchronizer-installation-guide-1 ### Description Provides the installation guide for the NexHealth synchronizer. ### Method GET ### Endpoint /nexhealth-synchronizer-installation-guide-1 ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **(type)** - Description #### Response Example { "example": "response body" } ``` -------------------------------- ### Getting Started Source: https://docs.nexhealth.com/v20240412/edit/getting-started Provides an overview and initial steps for using the NexHealth API. ```APIDOC ## GET /getting-started ### Description This endpoint provides introductory information and guidance for getting started with the NexHealth API. ### Method GET ### Endpoint /getting-started ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **content** (string) - The introductory content for the API. #### Response Example { "content": "Welcome to the NexHealth API! Here's how to get started..." } ``` -------------------------------- ### Guides Source: https://docs.nexhealth.com/v20240412/discuss/68c58ae6cad4223208274a7c Explore guides to help you get started with the NexHealth API. These guides provide step-by-step instructions and examples. ```APIDOC ## GET /v20240412/docs ### Description Accesses the guides for using the NexHealth API. ### Method GET ### Endpoint /v20240412/docs ### Parameters None ### Request Example None ### Response #### Success Response (200) - **guides** (array) - An array of available guides. #### Response Example ```json { "guides": [ { "title": "Getting Started", "url": "/docs/getting-started" } ] } ``` ``` -------------------------------- ### API Response Example for Postman Get Started Source: https://docs.nexhealth.com/v20240412/discuss_sorting=open This snippet shows example JSON responses for a GET request when getting started with Postman. It includes both a successful (200) and a bad request (400) response. ```json { "description": "Example JSON for a successful response." } ``` ```json { "description": "Example JSON for a bad request response." } ``` -------------------------------- ### Get started with Postman Source: https://docs.nexhealth.com/v20240412/edit/institutions-syncs-and-locations Guide on how to get started with Postman for interacting with the API. ```APIDOC ## GET /websites/nexhealth/working-with-postman ### Description Guide on how to get started with Postman for interacting with the API. ### Method GET ### Endpoint /websites/nexhealth/working-with-postman ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **response** (object) - Information on using Postman. ``` -------------------------------- ### Get started with scheduling Source: https://docs.nexhealth.com/discuss/68cd3c3469cafaaf079a7b68 Guide to getting started with appointment scheduling features. ```APIDOC ## GET /websites/nexhealth/book-an-appointment ### Description This endpoint is related to getting started with online appointment scheduling. ### Method GET ### Endpoint /websites/nexhealth/book-an-appointment ### Parameters This endpoint does not have any path, query, or request body parameters. ### Request Example (No request body for GET requests) ### Response #### Success Response (200) - **(object)** - Represents a successful response. The exact structure is `{}`. #### Error Response (400) - **(object)** - Represents an error response. The exact structure is `{}`. #### Response Example ```json { "example": "{}" } ``` ``` -------------------------------- ### Getting Started API Source: https://docs.nexhealth.com/v20240412/edit/setting-up-an-opendental-test-server This endpoint provides introductory information on how to get started with the NexHealth API. ```APIDOC ## GET /api/getting-started ### Description Provides introductory information for getting started with the NexHealth API. ### Method GET ### Endpoint /api/getting-started ### Parameters #### Path Parameters None #### Query Parameters None ### Request Example None ### Response #### Success Response (200) - **message** (string) - A welcome message and basic instructions. #### Response Example ```json { "message": "Welcome to the NexHealth API. Please refer to our documentation for integration guides." } ``` ``` -------------------------------- ### Getting Started Source: https://docs.nexhealth.com/v20240412/edit/automated-billing-setup Basic information and guidance on how to get started with the NexHealth API. ```APIDOC ## GET /api/getting-started ### Description Provides introductory information for using the NexHealth API. ### Method GET ### Endpoint /api/getting-started ### Parameters #### Path Parameters None #### Query Parameters None ### Request Example No request body needed. ### Response #### Success Response (200) - **message** (string) - A welcome message or introductory text. #### Response Example { "message": "Welcome to the NexHealth API!" } ``` -------------------------------- ### Get started with Postman Source: https://docs.nexhealth.com/v20240412/edit/interpreting-sync-status Guide to getting started with Postman for interacting with the Nexhealth API. ```APIDOC ## GET /websites/nexhealth/working-with-postman ### Description This endpoint provides instructions on how to use Postman to interact with the Nexhealth API. ### Method GET ### Endpoint /websites/nexhealth/working-with-postman ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **Instructions** (object) - Steps and examples for using Postman. #### Response Example ```json { "instructions": "..." } ``` ``` -------------------------------- ### Get Started with Postman Source: https://docs.nexhealth.com/v20240412/discuss_sorting=recent Guides for getting started with the NexHealth API using Postman. ```APIDOC ## GET /api/working-with-postman ### Description Provides instructions and examples for interacting with the NexHealth API using Postman. ### Method GET ### Endpoint /api/working-with-postman ### Parameters #### Query Parameters None ### Request Example None ### Response #### Success Response (200) - **postman_guide** (string) - A detailed guide on using Postman with the NexHealth API. - **example_requests** (object) - Example Postman requests. - **get_started** (object) - Example for a basic GET request. - **url** (string) - Example endpoint URL. - **headers** (object) - Example headers. - **authentication** (object) - Example for authentication requests. - **url** (string) - Example authentication endpoint URL. - **method** (string) - Example authentication method. #### Response Example ```json { "postman_guide": "Use Postman to test NexHealth endpoints by following these steps...", "example_requests": { "get_started": { "url": "https://api.nexhealth.com/v1/status", "headers": {"Authorization": "Bearer YOUR_API_KEY"} }, "authentication": { "url": "https://auth.nexhealth.com/oauth/token", "method": "POST" } } } ``` ``` -------------------------------- ### NexHealth synchronizer installation guide Source: https://docs.nexhealth.com/v20240412/edit/get-started-with-payments-v2 Provides a guide for installing the NexHealth synchronizer. ```APIDOC ## GET /api/installation-guide ### Description Provides a guide for installing the NexHealth synchronizer. ### Method GET ### Endpoint /api/installation-guide ### Parameters #### Path Parameters None #### Query Parameters None ### Request Example ```json { "example": "Not applicable for this endpoint" } ``` ### Response #### Success Response (200) - **guide** (string) - Step-by-step instructions for installation. #### Response Example ```json { "guide": "1. Download the installer. 2. Run the executable..." } ``` ``` -------------------------------- ### Getting started Source: https://docs.nexhealth.com/v20240412/edit/get-started-with-payments-v2 This section provides introductory information on how to get started with the NexHealth API. ```APIDOC ## GET /api/getting-started ### Description Provides introductory information on how to get started with the NexHealth API. ### Method GET ### Endpoint /api/getting-started ### Parameters #### Path Parameters None #### Query Parameters None ### Request Example ```json { "example": "Not applicable for this endpoint" } ``` ### Response #### Success Response (200) - **data** (object) - Contains introductory information. #### Response Example ```json { "data": { "message": "Welcome to NexHealth API!" } } ``` ``` -------------------------------- ### Working with Postman API Source: https://docs.nexhealth.com/v20240412/discuss-new This API endpoint is for getting started with Postman, likely providing foundational information or an initial setup guide. It requires authentication. ```APIDOC ## GET /websites/nexhealth/working-with-postman ### Description Guides users on how to get started with Postman for interacting with NexHealth APIs. ### Method GET ### Endpoint /websites/nexhealth/working-with-postman ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) ```json {} ``` #### Response Example ```json {} ``` ``` -------------------------------- ### Get Started with Postman API Source: https://docs.nexhealth.com/discuss_sorting=recent Guide on how to get started with NexHealth APIs using Postman. ```APIDOC ## GET /api/working-with-postman ### Description Instructions and guidance for using Postman to interact with NexHealth APIs. ### Method GET ### Endpoint /api/working-with-postman ### Parameters None ### Request Example None ### Response #### Success Response (200) - **data** (object) - Contains steps and examples for using Postman. #### Response Example ```json { "data": {} } ``` ``` -------------------------------- ### Onboarding Your First Customer API Source: https://docs.nexhealth.com/edit/nexhealth-synchronizer-installation-guide Guides and resources for onboarding new customers. ```APIDOC ## GET /api/onboarding-guide ### Description Provides information and steps required for onboarding a new customer. ### Method GET ### Endpoint /api/onboarding-guide ### Parameters #### Query Parameters None ### Request Example ```json { "example": "No request body needed for this GET request." } ``` ### Response #### Success Response (200) - **guide_steps** (array) - A list of steps for customer onboarding. - **resources** (object) - Links to relevant documentation and resources. #### Response Example ```json { "example": "{\"guide_steps\": [\"Step 1: Initial Setup\", \"Step 2: Configuration\"], \"resources\": {\"documentation\": \"/docs/onboarding\"}}" } ``` ``` -------------------------------- ### Get Started with Postman API Source: https://docs.nexhealth.com/v20240412/edit/troubleshooting-installs This endpoint is part of the 'Start Building' section and guides users on how to get started with Postman. It requires authentication. ```APIDOC ## GET /websites/nexhealth/start-building/working-with-postman ### Description Provides instructions and resources for getting started with Postman for API interactions. ### Method GET ### Endpoint /websites/nexhealth/start-building/working-with-postman ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **content** (string) - Markdown content explaining how to use Postman. #### Response Example ```json { "message": "Postman getting started guide content." } ``` ``` -------------------------------- ### Get started with scheduling Source: https://docs.nexhealth.com/v20240412/changelog_page=4 This endpoint guides users on how to get started with scheduling functionalities provided by NexHealth. ```APIDOC ## GET /websites/nexhealth/api ### Description This endpoint is for getting started with NexHealth's scheduling features. It requires authentication. ### Method GET ### Endpoint /websites/nexhealth/api ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **data** (object) - Response body, typically an empty JSON object in this case. #### Response Example ```json {} ``` #### Error Response (400) - **error** (object) - Error details. #### Response Example ```json {} ``` ``` -------------------------------- ### POST /api/installations/synchronizer Source: https://docs.nexhealth.com/edit/approaching-your-first-installation Guides through the installation process for the NexHealth synchronizer. ```APIDOC ## POST /api/installations/synchronizer ### Description Provides guidance and initiates the installation process for the NexHealth synchronizer. ### Method POST ### Endpoint /api/installations/synchronizer ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **installationConfig** (object) - Required - Configuration details for the synchronizer installation. - **ehrSystem** (string) - Required - The EHR system to integrate with. - **customerId** (string) - Required - The ID of the customer for whom the synchronizer is being installed. ### Request Example ```json { "installationConfig": { "ehrSystem": "EHR_SYSTEM_A", "customerId": "cust_abc123" } } ``` ### Response #### Success Response (200) - **installationId** (string) - A unique identifier for the synchronizer installation. - **message** (string) - A confirmation message regarding the installation process. #### Response Example ```json { "installationId": "inst_xyz789", "message": "NexHealth synchronizer installation initiated successfully." } ``` ``` -------------------------------- ### Get started with scheduling Source: https://docs.nexhealth.com/v20240412/discuss/68beb1f3f52782b7f105c679 This endpoint guides users on how to get started with appointment scheduling and online booking widgets. ```APIDOC ## GET /websites/nexhealth/book-an-appointment ### Description Get started with scheduling appointments and creating online booking widgets. ### Method GET ### Endpoint /websites/nexhealth/book-an-appointment ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **body** (object) - Information on how to book an appointment. ``` -------------------------------- ### GET /nexhealth-synchronizer-installation-guide Source: https://docs.nexhealth.com/v20240412/docs/using-the-nexhealth-developer-portal__hsenc=p2ANqtz-_C_LZ_iyGfgSWLZrm7NtOs9A3fxzATK42lQcs8mDHxn6j3Bpn2_LNg6Ydj5S-iFDfW2d52 Provides instructions for installing the NexHealth synchronizer. ```APIDOC ## GET /nexhealth-synchronizer-installation-guide ### Description This endpoint provides the guide for installing the NexHealth synchronizer. ### Method GET ### Endpoint /nexhealth-synchronizer-installation-guide ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **guide** (string) - The installation guide content. #### Response Example ```json { "guide": "Detailed steps for NexHealth synchronizer installation..." } ``` ``` -------------------------------- ### Get Started with Postman API Source: https://docs.nexhealth.com/v20240412/discuss API documentation for getting started with Postman, including request and response examples. ```APIDOC ## GET /websites/nexhealth/working-with-postman ### Description Guides users on how to get started with Postman for interacting with APIs. ### Method GET ### Endpoint /websites/nexhealth/working-with-postman ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **documentation** (string) - Content detailing how to use Postman. - **results** (object) - Contains example request and response codes. - **results.codes** (array) - Array of code examples. - **codes.name** (string) - Name of the code example. - **codes.code** (string) - The code snippet. - **codes.language** (string) - Language of the code snippet (e.g., json). - **codes.status** (integer) - HTTP status code. #### Response Example ```json { "documentation": "Instructions for Postman usage...", "results": { "codes": [ { "name": "Success Example", "code": "{}", "language": "json", "status": 200 }, { "name": "Error Example", "code": "{}", "language": "json", "status": 400 } ] } } ``` ``` -------------------------------- ### Getting Started API Source: https://docs.nexhealth.com/edit/setting-up-an-open-dental-test-server This section details the 'Getting Started' API endpoint, outlining its method, parameters, and response codes. ```APIDOC ## GET /api/getting-started ### Description This endpoint provides introductory information for getting started with the NexHealth API. ### Method GET ### Endpoint /api/getting-started ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```json { "example": "No request body needed for this GET request." } ``` ### Response #### Success Response (200) - **response** (object) - An object containing introductory API information. #### Response Example ```json { "example": "{}" } ``` #### Error Response (400) - **error** (object) - An object containing error details. #### Response Example ```json { "example": "{}" } ``` ``` -------------------------------- ### Getting started Source: https://docs.nexhealth.com/v20240412/edit/working-with-postman Information on how to get started with the NexHealth API. ```APIDOC ## GET /websites/nexhealth/getting-started ### Description Provides initial setup and usage information for the NexHealth API. ### Method GET ### Endpoint /websites/nexhealth/getting-started ### Parameters None ### Request Example None ### Response #### Success Response (200) Information related to getting started with the NexHealth API. #### Response Example { "message": "Successfully retrieved getting started information." } ``` -------------------------------- ### Get started with Postman Source: https://docs.nexhealth.com/discuss/68cd3c3469cafaaf079a7b68 This guide explains how to get started with the NexHealth API using Postman. It covers authentication and basic request structures. ```APIDOC ## GET /api/postman/getting-started ### Description Instructions on how to use Postman to interact with the NexHealth API, including authentication setup. ### Method GET ### Endpoint /api/postman/getting-started ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) Steps and examples for using Postman with the NexHealth API. #### Error Response (400) Bad request details. #### Response Example { "postman_guide": [ "Import the NexHealth Postman collection.", "Set up your API key in the environment variables.", "Send a GET request to the /api/glossary endpoint." ] } ### Error Handling - **400 Bad Request**: Indicates an issue with the request. ``` -------------------------------- ### Getting Started Source: https://docs.nexhealth.com/edit/supported-health-record-systems Provides an overview of how to get started with the NexHealth API, including authentication requirements. ```APIDOC ## GET /api/getting-started ### Description This endpoint provides basic information for getting started with the NexHealth API. It outlines the initial setup and authentication process. ### Method GET ### Endpoint /api/getting-started ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **message** (string) - A welcome message and instructions for using the API. #### Response Example ```json { "message": "Welcome to the NexHealth API! To get started, please ensure you have your API key and follow the authentication guidelines." } ``` ``` -------------------------------- ### NexHealth Synchronizer Installation Guide Source: https://docs.nexhealth.com/v20240412/edit/nexhealth-synchronizer-installation-guide Instructions for installing and setting up the NexHealth synchronizer. ```APIDOC ## GET /api/synchronizer/installation-guide ### Description Provides a step-by-step guide for installing and configuring the NexHealth synchronizer. ### Method GET ### Endpoint /api/synchronizer/installation-guide ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **guide** (string) - The installation guide content. #### Response Example { "guide": "Installation steps..." } ``` -------------------------------- ### Getting Started API Source: https://docs.nexhealth.com/v20240412/edit/supported-health-record-systems Provides introductory information on how to get started with the NexHealth API. ```APIDOC ## GET /websites/nexhealth/getting-started ### Description This endpoint provides introductory information for getting started with the NexHealth API. ### Method GET ### Endpoint /websites/nexhealth/getting-started ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **(object)** - Introductory information for NexHealth API. #### Response Example ```json { "message": "Welcome to the NexHealth API documentation. Please refer to the documentation for specific endpoints." } ``` ``` -------------------------------- ### Get Started with Payments API Requests Source: https://docs.nexhealth.com/v20240412/changelog_page=4 This entry describes how to get started with payments, using a GET API method that requires authentication. No specific parameters or response examples are provided in this snippet. ```json { "api": { "method": "get", "url": "", "auth": "required", "params": [] }, "title": "Get started with payments", "type": "basic", "slug": "get-started-with-payments-v2" } ``` -------------------------------- ### NexHealth synchronizer installation guide Source: https://docs.nexhealth.com/v20240412/edit/getting-started-with-ledger-data Instructions for installing the NexHealth synchronizer. ```APIDOC ## GET /websites/nexhealth/nexhealth-synchronizer-installation-guide-1 ### Description Provides a step-by-step guide for installing the NexHealth synchronizer. ### Method GET ### Endpoint /websites/nexhealth/nexhealth-synchronizer-installation-guide-1 ### Parameters #### Path Parameters None #### Query Parameters None ### Request Example None ### Response #### Success Response (200) An empty JSON object is returned as a placeholder. #### Response Example ```json {} ``` ``` -------------------------------- ### GET /working-with-postman Source: https://docs.nexhealth.com/v20240412/docs/using-the-nexhealth-developer-portal__hsenc=p2ANqtz-_C_LZ_iyGfgSWLZrm7NtOs9A3fxzATK42lQcs8mDHxn6j3Bpn2_LNg6Ydj5S-iFDfW2d52 Guide on how to get started with Postman for interacting with NexHealth APIs. ```APIDOC ## GET /working-with-postman ### Description This guide explains how to use Postman to interact with NexHealth APIs, including authentication and request examples. ### Method GET ### Endpoint /working-with-postman ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **postman_guide** (string) - The guide content for using Postman. - **example_requests** (object) - Examples of API requests. - **authentication_info** (string) - Information on API authentication. #### Response Example ```json { "postman_guide": "Instructions on setting up Postman collections...", "example_requests": { "get_users": { "method": "GET", "url": "/api/users" } }, "authentication_info": "Use your API key in the Authorization header." } ``` ``` -------------------------------- ### Getting started Source: https://docs.nexhealth.com/v20240412/edit/getting-started-with-ledger-data Basic information to get you started with the NexHealth API. ```APIDOC ## GET /websites/nexhealth ### Description Provides general information and getting started guide for the NexHealth API. ### Method GET ### Endpoint /websites/nexhealth ### Parameters #### Path Parameters None #### Query Parameters None ### Request Example None ### Response #### Success Response (200) An empty JSON object is returned as a placeholder. #### Response Example ```json {} ``` ``` -------------------------------- ### Get started with scheduling Source: https://docs.nexhealth.com/edit/working-with-postman This endpoint guides users on how to get started with the scheduling functionality, including booking appointments. It specifies authentication needs and response codes. ```APIDOC ## GET /api/scheduling/getting-started ### Description This endpoint provides information on how to begin using the appointment scheduling features. Authentication is required to access this documentation. ### Method GET ### Endpoint /api/scheduling/getting-started ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **guide** (string) - Instructions and details on how to use the scheduling feature. #### Response Example ```json { "message": "Scheduling getting started guide retrieved.", "guide": "Begin by configuring your availability..." } ``` #### Error Response (400) - **error** (object) - Details regarding a bad request. #### Error Response Example ```json { "message": "Invalid request parameters.", "error": {} } ``` ``` -------------------------------- ### POST /api/onboarding/customer Source: https://docs.nexhealth.com/edit/approaching-your-first-installation Initiates the onboarding process for a new customer. ```APIDOC ## POST /api/onboarding/customer ### Description Initiates the onboarding process for a new customer, likely involving configuration and setup steps. ### Method POST ### Endpoint /api/onboarding/customer ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **customerDetails** (object) - Required - Details of the customer to be onboarded. - **name** (string) - Required - The name of the customer. - **contactEmail** (string) - Required - The contact email for the customer. ### Request Example ```json { "customerDetails": { "name": "Example Clinic", "contactEmail": "contact@exampleclinic.com" } } ``` ### Response #### Success Response (200) - **onboardingId** (string) - A unique identifier for the onboarding process. - **status** (string) - The current status of the onboarding process. #### Response Example ```json { "onboardingId": "onb_12345abcde", "status": "initiated" } ``` ```