# List patients by department (athenahealth)

Operation ID: `connectors.athenaListPatientsByDepartment`

List patients by department via athenahealth. Returns a list of AthenaPatient records.

## Public method

`listPatientsByDepartment`

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

Return type: `Promise<AthenaHealthListPatientsByDepartmentResult>`

## Authentication

Classification: **AUTHENTICATED**

Schemes: `bearerAuth`

## Prerequisites

None documented.

## HTTP

`POST /connectors/athena-health/list-patients-by-department`

## Path parameters

None.

## Query parameters

None.

## Body parameters

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

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

## Request example

```json
{
  "department_id": "1",
  "last_name": "Smoketest",
  "limit": 100,
  "max_pages": 1,
  "mode": "sandbox",
  "practice_id": "1959418",
  "provider_id": "26",
  "secret_key": "example-api-key"
}
```

## Success responses

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

## Success response examples

### 200

```json
[
  {
    "address": {
      "country": "US",
      "line1": "123 Main St",
      "zip": "02110"
    },
    "date_of_birth": "01/15/1990",
    "department_id": "1",
    "email": "patient@example.com",
    "first_name": "Repl",
    "last_name": "Smoketest",
    "mobile_phone": "+15555550123",
    "patient_id": "948882",
    "primary_department_id": "1",
    "race": [],
    "sex": "M",
    "status": "active"
  }
]
```

## 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": "1",
  "last_name": "Smoketest",
  "limit": 100,
  "max_pages": 1,
  "mode": "sandbox",
  "practice_id": "1959418",
  "provider_id": "26",
  "secret_key": "example-api-key"
};

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

## cURL

```bash
curl -X POST \
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{"department_id":"1","last_name":"Smoketest","limit":100,"max_pages":1,"mode":"sandbox","practice_id":"1959418","provider_id":"26","secret_key":"example-api-key"}' \
  'https://dev-api-connectors.health.cloud/connectors/athena-health/list-patients-by-department'
```

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