# List insurance (athenahealth)

Operation ID: `connectors.athenaListInsurance`

List insurance via athenahealth. Returns a list of AthenaInsurance records.

## Public method

`listInsurance`

Signature: `connectors.athena.createClient(config).listInsurance(body)`

Return type: `Promise<AthenaHealthListInsuranceResult>`

## Authentication

Classification: **AUTHENTICATED**

Schemes: `bearerAuth`

## Prerequisites

None documented.

## HTTP

`POST /connectors/athena-health/list-insurance`

## Path parameters

None.

## Query parameters

None.

## Body parameters

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

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

## Request example

```json
{
  "department_id": "12345",
  "mode": "sandbox",
  "patient_id": "12345",
  "practice_id": "12345",
  "provider_id": "12345",
  "secret_key": "example-api-key"
}
```

## Success responses

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

## Success response examples

### 200

```json
[
  {
    "created": "example-created",
    "eligibility_status": "example-eligibility-status",
    "insurance_id": "12345",
    "irc_name": "Example Name",
    "last_updated": "example-last-updated",
    "member_id": "12345",
    "package_id": "12345",
    "plan_name": "Example Name",
    "relationship_to_insured": "example-relationship-to-insured",
    "type": "example-type"
  }
]
```

## 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";
```

```ts
const body = {
  "department_id": "12345",
  "mode": "sandbox",
  "patient_id": "12345",
  "practice_id": "12345",
  "provider_id": "12345",
  "secret_key": "example-api-key"
};

const result = await connectors.athena.createClient(config).listInsurance(body);
```

## cURL

```bash
curl -X POST \
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{"department_id":"12345","mode":"sandbox","patient_id":"12345","practice_id":"12345","provider_id":"12345","secret_key":"example-api-key"}' \
  'https://dev-api-connectors.health.cloud/connectors/athena-health/list-insurance'
```

## 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.