# Get a single provider by NPI

Operation ID: `connectors.zocdocGetProviderByNpi`

Get a single provider by NPI. Calls Zocdoc through the HealthCloud connector gateway.

## Public method

`getProviderByNpi`

Signature: `connectors.zocdoc.createClient(config).getProviderByNpi(body)`

Return type: `Promise<ZocdocGetProviderByNpiResult>`

## Authentication

Classification: **AUTHENTICATED**

Schemes: `bearerAuth`

## Prerequisites

None documented.

## HTTP

`POST /connectors/zocdoc/get-provider-by-npi`

## Path parameters

None.

## Query parameters

None.

## Body parameters

| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|---|---|---:|---|---|---|---:|---|
| `body` | [`ZocdocGetProviderByNpiRequest`](../models/ZocdocGetProviderByNpiRequest.md) | Yes |  |  |  | No |  |

Request model: [`ZocdocGetProviderByNpiRequest`](../models/ZocdocGetProviderByNpiRequest.md)

## Request example

```json
{
  "client_id": "12345",
  "client_secret": "example-client-secret",
  "insurance_plan_id": "12345",
  "mode": "sandbox",
  "npi": "example-npi"
}
```

## Success responses

| Status | Shape | Content type | Description |
|---|---|---|---|
| `200` | [`ZocdocGetProviderByNpiResponse`](../models/ZocdocGetProviderByNpiResponse.md) | application/json | Successful response |

## Success response examples

### 200

```json
{
  "bio": "example-bio",
  "first_name": "Ada",
  "gender_identity": "example-gender-identity",
  "languages": [],
  "last_name": "Lovelace",
  "locations": [],
  "middle_name": "Example Name",
  "npi": "example-npi",
  "profile_image_url": "https://example.com/resource",
  "provider_id": "12345",
  "specialties": [],
  "title": "example-title",
  "visit_reasons": []
}
```

## Common errors

| Status | Shape | Content type | Description |
|---|---|---|---|
| `400` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | Connector validation rejected the payload, or a required field was missing or of the wrong type. |
| `401` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | The HealthCloud bearer token is missing or invalid, or the vendor rejected the supplied connector credentials. |
| `500` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | The connector failed unexpectedly. |
| `502` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | The vendor returned an application or transport-level failure. |
| `504` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | The vendor did not respond within the connector timeout. |

## Error examples

### 400 — Invalid request

```json
{
  "error": "Invalid request"
}
```

### 401 — Authorization required

```json
{
  "error": "Authorization required"
}
```

### 500 — Internal error

```json
{
  "error": "Internal error"
}
```

### 502 — Upstream vendor error

```json
{
  "error": "Upstream vendor error"
}
```

### 504 — Upstream timeout

```json
{
  "error": "Upstream timeout"
}
```

## NodeJS / TypeScript implementation

```ts
import { HCSDK } from "@healthcloudai/hc-sdk";
import type { ZocdocGetProviderByNpiRequest } from "@healthcloudai/hc-sdk";
```

```ts
const body = {
  "client_id": "12345",
  "client_secret": "example-client-secret",
  "insurance_plan_id": "12345",
  "mode": "sandbox",
  "npi": "example-npi"
};

const result = await connectors.zocdoc.createClient(config).getProviderByNpi(body);
```

## cURL

```bash
curl -X POST \
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{"client_id":"12345","client_secret":"example-client-secret","insurance_plan_id":"12345","mode":"sandbox","npi":"example-npi"}' \
  'https://dev-api-connectors.health.cloud/connectors/zocdoc/get-provider-by-npi'
```

## Notes

None.

## Prepared Test Console scenario

No canonical scenario is currently associated.

## Real response

No approved real integration response is currently published. Unapproved candidates are never rendered as examples.