# All patients for the environment, with Contact/Org joins flattened

Operation ID: `connectors.salesforceListPatients`

All patients for the environment, with Contact/Org joins flattened. Calls Salesforce through the HealthCloud connector gateway.

## Public method

`listPatients`

Signature: `connectors.salesforce.createClient(config).listPatients(body)`

Return type: `Promise<SalesforceListPatientsResult>`

## Authentication

Classification: **AUTHENTICATED**

Schemes: `bearerAuth`

## Prerequisites

None documented.

## HTTP

`POST /connectors/salesforce/list-patients`

## Path parameters

None.

## Query parameters

None.

## Body parameters

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

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

## Request example

```json
{
  "api_key": "example-api-key",
  "api_secret": "example-api-key",
  "client_id": "3MVG9XgkMlifdwVB2Y8B0PCdoUWqk5t.ypBYSWW7mIyTQBPPZS30mjIpd_vX0cmYEAQ.NqCE5KSuL7zts8sx7",
  "client_secret": "example-client-secret",
  "environment": "dev",
  "login_url": "https://login.salesforce.com/services/oauth2/token",
  "mode": "sandbox",
  "password": "example-password",
  "username": "patient@example.com"
}
```

## Success responses

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

## Success response examples

### 200

```json
[
  {
    "city": "San Jose",
    "contact": "example-contact",
    "ehr_id": "946998",
    "email": "patient@example.com",
    "environment": "dev",
    "first_name": "Donnell",
    "healthcare_organization": "example-healthcare_organization",
    "healthcare_organization_name": "Healthcheck Systems Inc.",
    "id": "example-id",
    "include": [],
    "last_name": "Dicki",
    "name": "HC-1002",
    "phone": "+15555550123",
    "state": "CA",
    "street_address": "415 Stokes Street",
    "tenant_id": "healthcheck",
    "zip_code": "95126"
  }
]
```

## 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 { SalesforceListPatientsRequest } from "@healthcloudai/hc-sdk";
```

```ts
const body = {
  "api_key": "example-api-key",
  "api_secret": "example-api-key",
  "client_id": "3MVG9XgkMlifdwVB2Y8B0PCdoUWqk5t.ypBYSWW7mIyTQBPPZS30mjIpd_vX0cmYEAQ.NqCE5KSuL7zts8sx7",
  "client_secret": "example-client-secret",
  "environment": "dev",
  "login_url": "https://login.salesforce.com/services/oauth2/token",
  "mode": "sandbox",
  "password": "example-password",
  "username": "patient@example.com"
};

const result = await connectors.salesforce.createClient(config).listPatients(body);
```

## cURL

```bash
curl -X POST \
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{"api_key":"example-api-key","api_secret":"example-api-key","client_id":"3MVG9XgkMlifdwVB2Y8B0PCdoUWqk5t.ypBYSWW7mIyTQBPPZS30mjIpd_vX0cmYEAQ.NqCE5KSuL7zts8sx7","client_secret":"example-client-secret","environment":"dev","login_url":"https://login.salesforce.com/services/oauth2/token","mode":"sandbox","password":"example-password","username":"patient@example.com"}' \
  'https://dev-api-connectors.health.cloud/connectors/salesforce/list-patients'
```

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