# Get patient (Salesforce)

Operation ID: `connectors.salesforceGetPatient`

Get patient via Salesforce. Returns a SalesforcePatient record.

## Public method

`getPatient`

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

Return type: `Promise<SalesforceGetPatientResult>`

## Authentication

Classification: **AUTHENTICATED**

Schemes: `bearerAuth`

## Prerequisites

None documented.

## HTTP

`POST /connectors/salesforce/get-patient`

## Path parameters

None.

## Query parameters

None.

## Body parameters

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

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

## Request example

```json
{
  "api_key": "example-api-key",
  "api_secret": "example-api-key",
  "client_id": "12345",
  "client_secret": "example-client-secret",
  "environment": "dev",
  "mode": "sandbox",
  "password": "example-password",
  "patient_id": "12345",
  "username": "example-username"
}
```

## Success responses

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

## Success response examples

### 200

```json
{
  "additional_data": "example-additional-data",
  "address_extension": "example-address-extension",
  "birthdate": "example-birthdate",
  "city": "Boston",
  "contact": "example-contact",
  "ehr_id": "12345",
  "ehr_system": "example-ehr-system",
  "email": "patient@example.com",
  "environment": "example-environment",
  "first_name": "Ada",
  "gender": "example-gender",
  "healthcare_organization": "example-healthcare-organization",
  "healthcare_organization_name": "Example Name",
  "id": "12345",
  "include": [
    "example-include"
  ],
  "last_name": "Lovelace",
  "middle_name": "Example Name",
  "name": "Example Name",
  "phone": "+15555550123",
  "state": "MA",
  "street_address": "example-street-address",
  "summary": "example-summary",
  "tenant_id": "12345",
  "zip_code": "02116"
}
```

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

```ts
const body = {
  "api_key": "example-api-key",
  "api_secret": "example-api-key",
  "client_id": "12345",
  "client_secret": "example-client-secret",
  "environment": "dev",
  "mode": "sandbox",
  "password": "example-password",
  "patient_id": "12345",
  "username": "example-username"
};

const result = await connectors.salesforce.createClient(config).getPatient(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":"12345","client_secret":"example-client-secret","environment":"dev","mode":"sandbox","password":"example-password","patient_id":"12345","username":"example-username"}' \
  'https://dev-api-connectors.health.cloud/connectors/salesforce/get-patient'
```

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