NexHealth API

https://docs.nexhealth.com/v20240412/
Admin
NexHealth API is a universal healthcare integration platform that enables developers to connect with...
Tokens:1,482,690
Snippets:6,326
Trust Score:9.5
Update:1 year ago
Show doc for...
Tokens:
Raw
### Getting started

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 general information and introductory details 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)
- **message** (string) - A welcome message or introductory text.

#### Response Example
```json
{
  "message": "Welcome to the NexHealth API!"
}
```
```

--------------------------------

### NexHealth Synchronizer Installation Guide

Source: https://docs.nexhealth.com/v20240412/discuss_sorting=open

This section provides instructions for installing the NexHealth synchronizer. It details the necessary steps and configurations required for a successful setup. No specific dependencies or input/output examples are detailed in this extract.

```markdown
NexHealth synchronizer installation guide
```

--------------------------------

### Getting Started

Source: https://docs.nexhealth.com/v20240412/edit/automated-billing-setup

Information on how to get started with the NexHealth API, including basic setup and authentication.

```APIDOC
## GET /api/getting-started

### Description
Provides essential information to begin using 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 or getting started instructions.

#### Response Example
```json
{
  "message": "Welcome to the NexHealth API. Please refer to our guides for integration."
}
```
```

--------------------------------

### Getting started

Source: https://docs.nexhealth.com/v20240412/edit/institutions-syncs-and-locations

Information on how to get started with the NexHealth API, including initial setup and basic concepts.

```APIDOC
## GET /api/getting-started

### Description
Provides introductory information and guidance 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 information and links.

#### Response Example
```json
{
  "data": {}
}
```
```

--------------------------------

### Get Started 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 using the NexHealth API via Postman.

```APIDOC
## GET /api/postman/guide

### Description
Provides instructions and examples for using the NexHealth API with Postman.

### Method
GET

### Endpoint
/api/postman/guide

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **guide_content** (string) - Markdown content detailing Postman usage.
- **example_requests** (object) - Example Postman requests.

#### Response Example
{
  "guide_content": "# Using NexHealth API with Postman\n\nFollow these steps to set up your Postman environment...",
  "example_requests": {
    "get_institutions": {
      "method": "GET",
      "url": "https://api.nexhealth.com/v1/institutions"
    }
  }
}
```

--------------------------------

### Getting Started API

Source: https://docs.nexhealth.com/v20240412/edit/nexhealth-synchronizer-installation-guide

This endpoint provides general information for getting started with the NexHealth API. It details basic setup and initial steps.

```APIDOC
## GET /api/getting-started

### Description
Provides basic information and initial steps 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)
- **data** (object) - Contains introductory information for the API.

#### Response Example
```json
{
  "message": "Welcome to the NexHealth API. Please refer to our documentation for integration details."
}
```
```

--------------------------------

### Get started with Postman Example

Source: https://docs.nexhealth.com/v20240412/edit/getting-started

This section provides guidance on getting started with Postman for interacting with the NexHealth API. It outlines the necessary steps and configurations.

```text
Get started with Postman
```

--------------------------------

### Get started with Postman

Source: https://docs.nexhealth.com/v20240412/edit/using-the-nexhealth-developer-portal

Documentation for getting started with Postman, including an example GET request and response structure.

```APIDOC
## GET /websites/nexhealth_v20240412/working-with-postman

### Description
Guides users on how to get started with Postman for interacting with the API.

### Method
GET

### Endpoint
/websites/nexhealth_v20240412/working-with-postman

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **message** (string) - A success message.

#### Response Example
```json
{
  "message": "Successfully retrieved Postman getting started guide."
}
```
```

--------------------------------

### Get started with Postman

Source: https://docs.nexhealth.com/v20240412/edit/setting-up-an-opendental-test-server

Guides users on how to get started with Postman for interacting with the API.

```APIDOC
## GET /websites/nexhealth_v20240412/working-with-postman

### Description
Instructions and examples for using Postman to interact with the NexHealth API.

### Method
GET

### Endpoint
/websites/nexhealth_v20240412/working-with-postman

### Parameters
No parameters are specified.

### Request Example
No request body is applicable for this GET request.

### Response
#### Success Response (200)
- **guide** (string) - Steps and information for using Postman.

#### Response Example
```json
{
  "guide": "..."
}
```

#### Error Response (400)
- **error** (string) - Description of the error.

#### Response Example
```json
{
  "error": "Invalid request."
}
```
```

--------------------------------

### Getting Started API

Source: https://docs.nexhealth.com/v20240412/edit/glossary

This endpoint provides basic information for getting started with the NexHealth API. It includes details on authentication and initial setup.

```APIDOC
## GET /

### Description
Provides basic information for getting started with the NexHealth API, including authentication details and initial setup guidance.

### Method
GET

### Endpoint
/

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
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 the authentication documentation to get started."
}
```

#### Error Response (400)
- **error** (string) - Description of the error.

#### Error Response Example
```json
{
  "error": "Invalid request or authentication failed."
}
```
```

--------------------------------

### Get started with Scheduling Example

Source: https://docs.nexhealth.com/v20240412/edit/getting-started

This section details how to get started with the scheduling features of NexHealth. It likely covers API endpoints or client-side methods for booking appointments.

```text
Get started with scheduling
```

--------------------------------

### Get started with Postman

Source: https://docs.nexhealth.com/v20240412/edit/troubleshooting-installs

Guides on how to get started with Postman for interacting with NexHealth APIs.

```APIDOC
## GET /websites/nexhealth_v20240412/working-with-postman

### Description
This endpoint provides documentation on how to use Postman to interact with NexHealth APIs, including setup and example requests.

### Method
GET

### Endpoint
/websites/nexhealth_v20240412/working-with-postman

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **Instructions** (string) - Step-by-step guide for using Postman.
- **Examples** (array) - Example requests and responses.

#### Response Example
```json
{
  "message": "Postman guide for NexHealth APIs.",
  "instructions": "1. Import the NexHealth Postman collection. 2. Authenticate your requests. 3. Send requests to the desired endpoints.",
  "examples": [
    {
      "endpoint": "/api/v1/appointments",
      "method": "GET",
      "description": "Retrieve a list of appointments."
    }
  ]
}
```
```

--------------------------------

### Get started with Payments Guide

Source: https://docs.nexhealth.com/v20240412/edit/getting-started

This guide explains how to integrate and start using the payment processing functionalities within the NexHealth platform. It may include API references and best practices.

```text
Get started with payments
```

--------------------------------

### Getting started

Source: https://docs.nexhealth.com/v20240412/edit/setting-up-an-opendental-test-server

This section provides an overview of how to get started with the NexHealth API.

```APIDOC
## GET /api/getting-started

### Description
Provides an introduction and basic usage 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 and introductory information.

#### Response Example
{
  "message": "Welcome to the NexHealth API!"
}
```

--------------------------------

### Get started with Postman

Source: https://docs.nexhealth.com/v20240412/changelog_page=2

This endpoint provides information on how to get started with Postman for interacting with our APIs. It outlines the basic setup and usage.

```APIDOC
## GET /api/get_started_with_postman

### Description
Provides instructions and guidance for using Postman to interact with the NexHealth API. This endpoint is useful for developers looking to test and integrate with our services.

### Method
GET

### Endpoint
/api/get_started_with_postman

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **response_body** (object) - A JSON object containing instructions and examples for using Postman.

#### Response Example
```json
{
  "message": "Instructions for Postman setup and usage."
}
```
```

--------------------------------

### Getting started

Source: https://docs.nexhealth.com/v20240412/edit/interpreting-sync-status

Information on how to get started with the NexHealth API.

```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
None

### Response
#### Success Response (200)
- **message** (string) - A welcome message or getting started guide.

#### Response Example
```json
{
  "message": "Welcome to the NexHealth API!"
}
```
```

--------------------------------

### Get Started with Postman

Source: https://docs.nexhealth.com/v20240412/discuss/68c58ae6cad4223208274a7c

Guides on how to get started with the NexHealth API using Postman.

```APIDOC
## GET /api/postman/getting-started

### Description
Provides introductory information for using the NexHealth API with Postman.

### Method
GET

### Endpoint
/api/postman/getting-started

### Parameters
(No parameters specified)

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **message** (string) - A welcome message and instructions.

#### Response Example
```json
{
  "message": "Welcome to the NexHealth API. Use Postman to explore endpoints."
}
```
```

--------------------------------

### Getting Started

Source: https://docs.nexhealth.com/v20240412/edit/whats-possible-with-nexhealth

This section provides introductory information on how to get started with the NexHealth API.

```APIDOC
## GET /api/getting-started

### Description
Provides introductory information and guidance 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)
- **data** (object) - Contains introductory information.

#### Response Example
```json
{
  "message": "Welcome to NexHealth API!"
}
```
```

--------------------------------

### GET /api/nexhealth-synchronizer-installation-guide

Source: https://docs.nexhealth.com/v20240412/discuss-new

Provides the installation guide for the NexHealth synchronizer tool.

```APIDOC
## GET /api/nexhealth-synchronizer-installation-guide

### Description
This endpoint provides access to the step-by-step guide for installing and setting up the NexHealth synchronizer.

### Method
GET

### Endpoint
/api/nexhealth-synchronizer-installation-guide

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **(object)** - The installation guide content.

#### Response Example
```json
{
  "example": "{}"
}
```
```

--------------------------------

### Get Started with Postman API Example

Source: https://docs.nexhealth.com/v20240412/discuss-new

This section provides an example of how to get started with Postman for API interactions. It includes sample successful (200 OK) and error (400 Bad Request) responses, both as empty JSON objects. The request method is GET and requires authentication.

```json
{
  "method": "get",
  "url": "",
  "auth": "required",
  "results": {
    "codes": [
      {
        "name": "",
        "code": "{}",
        "language": "json",
        "status": 200
      },
      {
        "name": "",
        "code": "{}",
        "language": "json",
        "status": 400
      }
    ]
  },
  "params": []
}
```

--------------------------------

### GET /websites/nexhealth_v20240412/nexhealth-synchronizer-installation-guide-1

Source: https://docs.nexhealth.com/v20240412/discuss

Provides the NexHealth synchronizer installation guide. This endpoint retrieves documentation related to setting up and installing the NexHealth synchronizer.

```APIDOC
## GET /websites/nexhealth_v20240412/nexhealth-synchronizer-installation-guide-1

### Description
Retrieves the installation guide for the NexHealth synchronizer.

### Method
GET

### Endpoint
/websites/nexhealth_v20240412/nexhealth-synchronizer-installation-guide-1

### Parameters
#### Path Parameters
None

#### Query Parameters
None

### Request Example
None

### Response
#### Success Response (200)
Returns the content of the NexHealth synchronizer installation guide.

#### Response Example
(Content will be the documentation for the installation guide)
```

--------------------------------

### Get started with payments

Source: https://docs.nexhealth.com/v20240412/edit/setting-up-an-opendental-test-server

Information on how to get started with payment functionalities.

```APIDOC
## GET /websites/nexhealth_v20240412/get-started-wi

### Description
Guidance on initiating and managing payments through the API.

### Method
GET

### Endpoint
/websites/nexhealth_v20240412/get-started-wi

### Parameters
No parameters are specified.

### Request Example
No request body is applicable for this GET request.

### Response
#### Success Response (200)
- **payment_guide** (string) - Instructions for payment processing.

#### Response Example
```json
{
  "payment_guide": "..."
}
```
```

--------------------------------

### Getting Started

Source: https://docs.nexhealth.com/v20240412/edit/working-with-postman

This section provides basic information on getting started with the NexHealth API.

```APIDOC
## Getting Started

### Description
This section provides basic information on getting started with the NexHealth API.

### Method
GET

### Endpoint
/

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **(object)** - Empty object for success.

#### Response Example
```json
{}
```
```

--------------------------------

### Automated Billing Setup Guide

Source: https://docs.nexhealth.com/v20240412/discuss_sorting=open

This guide explains the process of setting up automated billing within the NexHealth platform. It covers the configurations and steps required to enable automated billing functionality. Detailed code or configuration examples are not present in this snippet.

```markdown
Automated billing setup
```

--------------------------------

### GET /api/nexhealth-synchronizer-installation-guide

Source: https://docs.nexhealth.com/v20240412/discuss/68cd3c3469cafaaf079a7b68

Provides the installation guide for the NexHealth synchronizer. This endpoint is useful for setting up and configuring the synchronization service.

```APIDOC
## GET /api/nexhealth-synchronizer-installation-guide

### Description
Provides the installation guide for the NexHealth synchronizer. This endpoint is useful for setting up and configuring the synchronization service.

### Method
GET

### Endpoint
/api/nexhealth-synchronizer-installation-guide

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **body** (json) - Installation guide content.

#### Response Example
```json
null
```
```

--------------------------------

### Get started with Postman API

Source: https://docs.nexhealth.com/v20240412/edit/get-started-with-payments-v2

This endpoint provides guidance on getting started with Postman for interacting with the API.

```APIDOC
## GET /api/working-with-postman

### Description
Provides instructions or resources for using Postman to interact with the API.

### Method
GET

### Endpoint
/api/working-with-postman

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **response** (object) - Information on getting started with Postman.

#### Response Example
{
  "example": "{}"
}

#### Error Response (400)
- **error** (object) - Details about the error.

#### Response Example
{
  "example": "{}"
}
```

--------------------------------

### Example JSON Response for Patient Data

Source: https://docs.nexhealth.com/v20240412/docs/getting-started

This is a sample JSON response from the NexHealth API after a successful GET request to the /patients endpoint. It includes metadata like 'code', 'count', and 'description', along with a 'data' object containing a list of patient records.

```json
{
    "code": true,
    "data": {
        "patients": [{
            "id": 143776,
            "email": null,
            "first_name": "John",
            "last_name": "Smith",
            "created_at": "2020-08-12T19:17:22.575Z",
            "updated_at": "2020-08-12T19:25:17.591Z",
            "account_activated": false,
            "middle_name": null,
            "foreign_id": "19",
            "foreign_id_type": "msg-opendental-DataSource-35",
            "requested_access": false,
            "waitlisted_at": {},
            "inst_ids": [],
            "prov_ids": [],
            "config": {},
            "unsubscribe_emails": false,
            "last_import_id": "e872caee-8e2a-40dd-a403-ca7099040b8d",
            "invalid_email": [],
            "inactive": true,
            "last_sync": null,
            "last_sync_time": "2020-08-12T19:25:17.591Z",
            "unsubscribe_sms": false,
        }]
    },
    "description": [],
    "count": 35,
    "error": []
}
```

--------------------------------

### Get started with Postman

Source: https://docs.nexhealth.com/v20240412/edit/getting-started-with-ledger-data

This section provides guidance on getting started with Postman for API interactions.

```APIDOC
## GET /working-with-postman

### Description
This endpoint provides instructions and resources for using Postman to interact with the API.

### Method
GET

### Endpoint
/working-with-postman

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **documentation_url** (string) - URL to the Postman documentation.

#### Response Example
{
  "documentation_url": "https://docs.nexhealth.com/postman"
}
```

--------------------------------

### NexHealth synchronizer installation guide

Source: https://docs.nexhealth.com/v20240412/discuss_sorting=recent

Guide for installing the NexHealth synchronizer.

```APIDOC
## GET /websites/nexhealth_v20240412/nexhealth-synchronizer-installation-guide-1

### Description
This endpoint provides information on how to install the NexHealth synchronizer.

### Method
GET

### Endpoint
/websites/nexhealth_v20240412/nexhealth-synchronizer-installation-guide-1

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **body** (object) - Details about the synchronizer installation.

#### Response Example
```json
{
  "message": "Installation guide details will be provided here."
}
```
```

--------------------------------

### NexHealth synchronizer installation guide

Source: https://docs.nexhealth.com/v20240412/discuss_sorting=open

This guide provides instructions for installing and setting up the NexHealth synchronizer.

```APIDOC
## GET /api/synchronizer

### Description
Retrieves information about the NexHealth synchronizer installation.

### Method
GET

### Endpoint
/api/synchronizer

### Parameters
#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **data** (object) - Synchronizer installation details.

#### Response Example
```json
{
  "data": {}
}
```
```

--------------------------------

### NexHealth Synchronizer Installation Guide

Source: https://docs.nexhealth.com/v20240412/edit/glossary

Guide for installing the NexHealth synchronizer.

```APIDOC
## GET /api/nexhealth/synchronizer/installation

### Description
Retrieves the installation guide for the NexHealth synchronizer.

### Method
GET

### Endpoint
/api/nexhealth/synchronizer/installation

### 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 installing the NexHealth synchronizer..."
}
```
```

--------------------------------

### NexHealth Synchronizer Installation Guide

Source: https://docs.nexhealth.com/v20240412/discuss/68beb1f3f52782b7f105c679

Provides a guide for installing the NexHealth synchronizer.

```APIDOC
## NexHealth Synchronizer Installation Guide

### Description
This document outlines the steps required to install the NexHealth synchronizer.

### Method
GET

### Endpoint
/guides/nexhealth-synchronizer-installation

### Parameters
None

### Request Example
None

### Response
(Content of the installation guide would be detailed here, but is not available in the provided text.)
```

--------------------------------

### Get started with Postman

Source: https://docs.nexhealth.com/v20240412/discuss_sorting=open

This guide explains how to get started with Postman for interacting with the NexHealth API, including example requests and responses.

```APIDOC
## GET /api/postman/example

### Description
Provides an example request and response for testing with Postman.

### Method
GET

### Endpoint
/api/postman/example

### Parameters
#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **message** (string) - A success message.
- **data** (object) - Example data.

#### Response Example
```json
{
  "message": "Example data retrieved successfully.",
  "data": {}
}
```
```

--------------------------------

### GET /websites/nexhealth_v20240412/working-with-postman

Source: https://docs.nexhealth.com/v20240412/discuss

Guides users on how to get started with Postman for interacting with the NexHealth API. This endpoint provides introductory information and examples for API testing.

```APIDOC
## GET /websites/nexhealth_v20240412/working-with-postman

### Description
Provides instructions and examples for using Postman to interact with the NexHealth API.

### Method
GET

### Endpoint
/websites/nexhealth_v20240412/working-with-postman

### Parameters
#### Path Parameters
None

#### Query Parameters
None

### Request Example
None

### Response
#### Success Response (200)
Returns documentation on getting started with Postman for NexHealth API.

#### Response Example
{
  "example": "Get started with Postman instructions and API examples"
}
```

--------------------------------

### Get Started with Postman

Source: https://docs.nexhealth.com/v20240412/edit/glossary

Guide on how to get started with Postman for interacting with APIs.

```APIDOC
## GET /api/postman/get-started

### Description
Provides instructions and examples for using Postman to interact with NexHealth APIs.

### Method
GET

### Endpoint
/api/postman/get-started

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **instructions** (string) - Step-by-step guide for using Postman.
- **example_requests** (array) - Example API requests.

#### Response Example
```json
{
  "instructions": "1. Import the NexHealth Postman collection... 2. Authenticate your requests...",
  "example_requests": [
    {
      "description": "Get list of all institutions",
      "request": {
        "method": "GET",
        "url": "{{baseUrl}}/api/institutions"
      }
    }
  ]
}
```
```

--------------------------------

### Get started with Postman

Source: https://docs.nexhealth.com/v20240412/discuss_sorting=recent

Guide on how to get started with Postman for interacting with NexHealth APIs.

```APIDOC
## GET /websites/nexhealth_v20240412/working-with-postman

### Description
This endpoint offers a guide on using Postman to test and interact with NexHealth APIs.

### Method
GET

### Endpoint
/websites/nexhealth_v20240412/working-with-postman

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **postman_guide** (string) - Information on using Postman with NexHealth.
- **example_requests** (array) - Example API requests for Postman.

#### Response Example
```json
{
  "postman_guide": "Detailed steps on importing collections and making requests.",
  "example_requests": []
}
```
```

--------------------------------

### GET /getting-started

Source: https://docs.nexhealth.com/v20240412/discuss

Provides introductory information and guidance for getting started with the NexHealth platform. This page outlines the initial steps and concepts.

```APIDOC
## GET /getting-started

### Description
Provides introductory information and guidance for getting started with the NexHealth platform. This page outlines the initial steps and concepts.

### Method
GET

### Endpoint
/getting-started

### Parameters
No parameters are documented for this endpoint.

### Request Example
```
GET /getting-started
```

### Response
#### Success Response (200)
- The response for this endpoint is typically an HTML page with documentation content.

#### Response Example
(HTML content describing getting started guides)
```

--------------------------------

### Get Started with Postman

Source: https://docs.nexhealth.com/v20240412/discuss/68beb1f3f52782b7f105c679

A guide on how to get started with Postman for interacting with the NexHealth API.

```APIDOC
## Get Started with Postman

### Description
This guide explains how to use Postman to interact with the NexHealth API, including authentication and basic requests.

### Method
GET

### Endpoint
/guides/working-with-postman

### Parameters
None

### Request Example
None

### Response
(Instructions and examples for using Postman would be provided here, but are not available in the provided text.)
```

--------------------------------

### Introduction API

Source: https://docs.nexhealth.com/v20240412/docs/using-the-nexhealth-developer-portal__hsenc=p2ANqtz-_C_LZ_iyGfgSWLZrm7NtOs9A3fxzATK42lQcs8mDHxn6j3Bpn2_LNg6Ydj5S-iFDfW2d52

Provides an introduction to the NexHealth API, including basic information and setup.

```APIDOC
## GET /introduction

### Description
Retrieves introductory information about the NexHealth API.

### Method
GET

### Endpoint
/introduction

### 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
```json
{
  "message": "Welcome to the NexHealth API!"
}
```
```

--------------------------------

### Setting up an OpenDental test server

Source: https://docs.nexhealth.com/v20240412/edit/getting-started-with-ledger-data

Instructions for setting up a test server environment for OpenDental.

```APIDOC
## GET /setting-up-an-opendental-test-server

### Description
This endpoint provides a guide for setting up a test server environment specifically for OpenDental.

### Method
GET

### Endpoint
/setting-up-an-opendental-test-server

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **setup_guide** (string) - Link to the OpenDental test server setup guide.

#### Response Example
{
  "setup_guide": "https://docs.nexhealth.com/opendental/test-server-setup"
}
```

--------------------------------

### Get started with scheduling

Source: https://docs.nexhealth.com/v20240412/docs/using-the-nexhealth-developer-portal__hsenc=p2ANqtz-_C_LZ_iyGfgSWLZrm7NtOs9A3fxzATK42lQcs8mDHxn6j3Bpn2_LNg6Ydj5S-iFDfW2d52

This endpoint provides information on how to get started with scheduling appointments through the NexHealth platform.

```APIDOC
## GET /websites/nexhealth_v20240412/book-an-appointment

### Description
Provides guidance and resources for initiating appointment scheduling.

### Method
GET

### Endpoint
/websites/nexhealth_v20240412/book-an-appointment

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **body** (object) - Details about scheduling setup.

#### Response Example
```json
{} 
```
```

--------------------------------

### Get started with Postman API Request

Source: https://docs.nexhealth.com/v20240412/changelog_page=2

This snippet demonstrates a basic GET request setup in Postman. It specifies the authentication requirement and shows example JSON responses for success (200) and failure (400) statuses. No request parameters are defined.

```json
{
  "api": {
    "method": "get",
    "url": "",
    "auth": "required",
    "results": {
      "codes": [
        {
          "name": "",
          "code": "{}",
          "language": "json",
          "status": 200
        },
        {
          "name": "",
          "code": "{}",
          "language": "json",
          "status": 400
        }
      ]
    },
    "params": []
  },
  "title": "Get started with Postman",
  "type": "basic"
}
```

--------------------------------

### Get Started with Postman API

Source: https://docs.nexhealth.com/v20240412/edit/interpreting-sync-status

This endpoint guides users on how to get started with Postman for interacting with the NexHealth API.

```APIDOC
## GET /websites/nexhealth_v20240412/working-with-postman

### Description
This endpoint provides instructions for using Postman to interact with the NexHealth API.

### Method
GET

### Endpoint
/websites/nexhealth_v20240412/working-with-postman

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **instructions** (string) - Step-by-step guide for Postman usage.
- **example_request** (object) - Example request structure.
- **example_response** (object) - Example response structure.

#### Response Example
```json
{
  "instructions": "Follow these steps to use Postman...",
  "example_request": {},
  "example_response": {}
}
```
```

--------------------------------

### NexHealth Synchronizer Installation Guide

Source: https://docs.nexhealth.com/v20240412/edit/using-the-nexhealth-developer-portal

Instructions for installing and setting up the NexHealth synchronizer.

```APIDOC
## GET /api/installation-guide

### Description
Provides detailed steps and prerequisites for installing the NexHealth synchronizer.

### Method
GET

### Endpoint
/api/installation-guide

### Parameters
No parameters are available for this endpoint.

### Request Example
No request body is applicable.

### Response
#### Success Response (200)
- **guide** (string) - A string containing the installation guide instructions.

#### Response Example
```json
{
  "guide": "1. Download the synchronizer package... 2. Run the installer..."
}
```
```

--------------------------------

### NexHealth synchronizer installation guide

Source: https://docs.nexhealth.com/v20240412/edit/setting-up-an-opendental-test-server

Instructions for installing and setting up the NexHealth synchronizer.

```APIDOC
## GET /api/installation-guide

### Description
Provides a step-by-step guide for installing and configuring the NexHealth synchronizer on your systems.

### Method
GET

### Endpoint
/api/installation-guide

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **guide** (string) - A detailed installation guide in markdown format.

#### Response Example
{
  "guide": "# NexHealth Synchronizer Installation\n\n## Prerequisites\n... (rest of the guide)"
}
```

--------------------------------

### Get Started with Scheduling API

Source: https://docs.nexhealth.com/v20240412/edit/interpreting-sync-status

This endpoint guides users on how to get started with the scheduling features of NexHealth, including booking appointments.

```APIDOC
## GET /websites/nexhealth_v20240412/book-an-appointment

### Description
This endpoint provides information and guidance on booking appointments using the NexHealth scheduling system.

### Method
GET

### Endpoint
/websites/nexhealth_v20240412/book-an-appointment

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **scheduling_info** (string) - Information on how to book appointments.
- **booking_api_details** (object) - Details related to the appointment booking API.

#### Response Example
```json
{
  "scheduling_info": "Learn how to schedule appointments with NexHealth...",
  "booking_api_details": {
    "method": "POST",
    "endpoint": "/api/appointments",
    "parameters": [
      {
        "name": "patientId",
        "type": "string",
        "required": true,
        "description": "The ID of the patient."
      }
    ]
  }
}
```
```

--------------------------------

### Get started with scheduling

Source: https://docs.nexhealth.com/v20240412/edit/getting-started-with-ledger-data

API endpoints and guidance for interacting with the scheduling system.

```APIDOC
## GET /book-an-appointment

### Description
This endpoint allows users to book appointments through the scheduling system. It also provides links to create online booking widgets.

### Method
GET

### Endpoint
/book-an-appointment

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **booking_info** (string) - Information on how to book an appointment.
- **widget_creation_url** (string) - URL to create an online booking widget.

#### Response Example
{
  "booking_info": "Use the /appointments endpoint to book an appointment.",
  "widget_creation_url": "/create-booking-widget"
}
```

--------------------------------

### Getting Started API

Source: https://docs.nexhealth.com/v20240412/docs/using-the-nexhealth-developer-portal__hsenc=p2ANqtz-_C_LZ_iyGfgSWLZrm7NtOs9A3fxzATK42lQcs8mDHxn6j3Bpn2_LNg6Ydj5S-iFDfW2d52

This section provides an overview of the NexHealth API and its basic usage, including authentication and response codes.

```APIDOC
## GET /

### Description
Provides general information and setup for the NexHealth API.

### Method
GET

### Endpoint
/

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **message** (string) - A welcome message or status information.

#### Response Example
```json
{
  "message": "Welcome to the NexHealth API!"
}
```
```

--------------------------------

### Getting Started API

Source: https://docs.nexhealth.com/v20240412/discuss_sorting=open

This endpoint provides basic information for getting started with the NexHealth API. It outlines the initial steps and requirements for integration.

```APIDOC
## GET / 

### Description
Provides basic getting started information for the NexHealth API.

### Method
GET

### Endpoint
/

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **message** (string) - A welcome message or basic instructions.

#### Response Example
```json
{
  "message": "Welcome to the NexHealth API. Please refer to the documentation for integration details."
}
```
```

--------------------------------

### Getting Started API

Source: https://docs.nexhealth.com/v20240412/discuss_sorting=recent

This endpoint provides basic information for getting started with the NexHealth API.

```APIDOC
## GET /

### Description
Provides basic information for getting started with the NexHealth API.

### Method
GET

### Endpoint
/

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **data** (object) - Contains information relevant to getting started.

#### Response Example
```json
{
  "data": {}
}
```

#### Error Response (400)
- **error** (object) - Contains error details.

#### Response Example
```json
{
  "error": {}
}
```
```

--------------------------------

### Get started with scheduling

Source: https://docs.nexhealth.com/v20240412/changelog_page=4

This endpoint guides users on how to get started with scheduling appointments via the NexHealth API. It includes details on authentication, parameters, and expected success and error responses.

```APIDOC
## GET /api

### Description
Guides users on how to get started with scheduling appointments via the NexHealth API. It includes details on authentication, parameters, and expected success and error responses.

### Method
GET

### Endpoint
/api

### Parameters

#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **code** (json) - Example success response body.

#### Response Example
```json
{}
```

#### Error Response (400)
- **code** (json) - Example error response body.

#### Response Example
```json
{}
```
```

--------------------------------

### Setting up an OpenDental Test Server

Source: https://docs.nexhealth.com/v20240412/docs/using-the-nexhealth-developer-portal__hsenc=p2ANqtz-_C_LZ_iyGfgSWLZrm7NtOs9A3fxzATK42lQcs8mDHxn6j3Bpn2_LNg6Ydj5S-iFDfW2d52

Instructions for setting up a test server environment for OpenDental integration with NexHealth.

```APIDOC
## GET /api/opendental/test-server/setup

### Description
Provides a guide for setting up an OpenDental test server for NexHealth integration.

### Method
GET

### Endpoint
/api/opendental/test-server/setup

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **setup_guide** (string) - Markdown content with setup instructions.

#### Response Example
{
  "setup_guide": "# OpenDental Test Server Setup\n\n1. Download the OpenDental installer...\n2. Configure database settings..."
}
```

--------------------------------

### Get Started with Scheduling API

Source: https://docs.nexhealth.com/v20240412/discuss_sorting=recent

This section details how to get started with the scheduling API. It includes example JSON responses for successful (200) and bad request (400) scenarios. The API requires authentication.

```json
{
  "status": 200
}
```

```json
{
  "status": 400,
  "error": "Invalid request"
}
```

--------------------------------

### NexHealth Synchronizer Installation Guide

Source: https://docs.nexhealth.com/v20240412/docs/using-the-nexhealth-developer-portal__hsenc=p2ANqtz-_C_LZ_iyGfgSWLZrm7NtOs9A3fxzATK42lQcs8mDHxn6j3Bpn2_LNg6Ydj5S-iFDfW2d52

Information on how to install and configure the NexHealth synchronizer.

```APIDOC
## GET /api/synchronizer/installation

### Description
Retrieves the installation guide for the NexHealth synchronizer.

### Method
GET

### Endpoint
/api/synchronizer/installation

### 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": "Step-by-step instructions to install the NexHealth synchronizer..."
}
```

--------------------------------

### GET /api/websites/nexhealth_v20240412/nexhealth-synchronizer-installation-guide-1

Source: https://docs.nexhealth.com/v20240412/edit/access-procedure-codes

This endpoint provides the installation guide for the NexHealth synchronizer.

```APIDOC
## GET /api/websites/nexhealth_v20240412/nexhealth-synchronizer-installation-guide-1

### Description
Provides detailed instructions and guidance for installing the NexHealth synchronizer.

### Method
GET

### Endpoint
/api/websites/nexhealth_v20240412/nexhealth-synchronizer-installation-guide-1

### Parameters

#### Path Parameters

#### Query Parameters

#### Request Body

### Request Example

### Response
#### Success Response (200)
- **api** (object) - Contains API-specific details.
  - **method** (string) - The HTTP method used (e.g., 'get').
  - **url** (string) - The endpoint URL.
  - **auth** (string) - Authentication requirements ('required').
  - **params** (array) - An array of parameters.

#### Response Example
```json
{
  "api": {
    "method": "get",
    "url": "",
    "auth": "required",
    "params": []
  }
}
```
```

--------------------------------

### GET /api/working-with-postman

Source: https://docs.nexhealth.com/v20240412/discuss/68cd3c3469cafaaf079a7b68

Guides users on how to get started with Postman for interacting with NexHealth APIs. This endpoint is helpful for developers to test and integrate with the API.

```APIDOC
## GET /api/working-with-postman

### Description
Guides users on how to get started with Postman for interacting with NexHealth APIs. This endpoint is helpful for developers to test and integrate with the API.

### Method
GET

### Endpoint
/api/working-with-postman

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **body** (json) - Postman getting started guide.

#### Response Example
```json
{}
```

#### Error Response (400)
- **body** (json) - Error details.

#### Response Example
```json
{}
```
```

--------------------------------

### NexHealth Synchronizer Installation Guide - API Example

Source: https://docs.nexhealth.com/v20240412/discuss_sorting=recent

This snippet provides an example of API interaction for the NexHealth synchronizer installation. It details the HTTP method, authentication requirements, and sample JSON responses for success and error cases. This is useful for understanding how to integrate with the synchronizer.

```json
{
  "_id": "665a53db52c55b00129d0a48",
  "api": {
    "method": "get",
    "url": "",
    "auth": "required",
    "results": {
      "codes": [
        {
          "name": "",
          "code": "{}",
          "language": "json",
          "status": 200
        },
        {
          "name": "",
          "code": "{}",
          "language": "json",
          "status": 400
        }
      ]
    },
    "params": []
  },
  "title": "Get started with Postman",
  "type": "basic",
  "slug": "working-with-postman",
  "order": 0,
  "isReference": false,
  "deprecated": false,
  "hidden": false,
  "sync_unique": "",
  "link_url": "",
  "link_external": false,
  "previousSlug": "",
  "createdAt": "2022-05-09T17:26:34.954Z",
  "category": "665a53db52c55b00129d0a20",
  "parentDoc": null,
  "icon": "",
  "mdx": {},
  "isBodyEmpty": false,
  "children": []
}
```

--------------------------------

### Get Guarantor Balance (cURL Request Example)

Source: https://docs.nexhealth.com/v20240412/docs/get-started-with-payments-v2

Example cURL command to retrieve the balance information for a specific guarantor using the NexHealth API. This request requires a bearer token and specifies the API version and desired response format.

```curl
curl --request GET \
     --url 'https://nexhealth.info/guarantor_balances/{GUARANTOR_ID}?subdomain=YOUR_SUBDOMAIN&location_id=YOUR_LOCATION' \
     --header 'Nex-Api-Version: v20240412' \
     --header 'Accept: application/vnd.Nexhealth+json;version=2' \
     --header 'Authorization: Bearer YOUR_BEARER_TOKEN'    
```

--------------------------------

### Get Guarantor Balance (JSON Response Example)

Source: https://docs.nexhealth.com/v20240412/docs/get-started-with-payments-v2

Example JSON response when fetching a guarantor's balance using the NexHealth API. This structure provides details on total balance, insurance estimates, write-offs, and the specific amount the guarantor is responsible for (guarantor_portion).

```json
{
  "code": false,
  "description": "Description",
  "error": "Error",
  "data": {
    "id": 113,
    "foreign_id": "1",
    "guarantor_id": 115,
    "location_id": 115,
    "write_off_estimate": {
      "amount": "62.00",
      "currency": "USD"
    },
    "total_balance": {
      "amount": "62.00",
      "currency": "USD"
    },
    "insurance_estimate": {
      "amount": "62.00",
      "currency": "USD"
    },
    "guarantor_portion": {
      "amount": "62.00",
      "currency": "USD"
    }
  }
}
```

--------------------------------

### Getting Started API

Source: https://docs.nexhealth.com/v20240412/discuss/68cd3c3469cafaaf079a7b68

This section provides basic information for getting started with the NexHealth API. It includes details on authentication and expected response formats.

```APIDOC
## GET /api/getting-started

### Description
Retrieves 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 GET request"
}
```

### Response
#### Success Response (200)
- **response** (object) - Contains API information and details.

#### Response Example
```json
{
  "response": "{}"
}
```

#### Error Response (400)
- **response** (object) - Contains error details.

#### Response Example
```json
{
  "response": "{}"
}
```
```
Tokens:
Raw