# Accounts + campaigns + segments in one payload

Operation ID: `connectors.salesforceGetConfiguration`

Accounts + campaigns + segments in one payload. Calls Salesforce through the HealthCloud connector gateway.

## Public method

`getConfiguration`

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

Return type: `Promise<SalesforceGetConfigurationResult>`

## Authentication

Classification: **AUTHENTICATED**

Schemes: `bearerAuth`

## Prerequisites

None documented.

## HTTP

`POST /connectors/salesforce/get-configuration`

## Path parameters

None.

## Query parameters

None.

## Body parameters

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

Request model: [`SalesforceGetConfigurationRequest`](../models/SalesforceGetConfigurationRequest.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` | [`SalesforceGetConfigurationResponse`](../models/SalesforceGetConfigurationResponse.md) | application/json | Successful response |

## Success response examples

### 200

```json
{
  "accounts": [
    {
      "address": {
        "city": "LOS ANGELES",
        "country_code": "US",
        "postal_code": "90019",
        "state_code": "CA",
        "street": "Test 1532 S"
      },
      "created_date": "2025-05-06T21:53:17.000+0000",
      "default_region": "us-west-1",
      "ehr_department_id": "1",
      "ehr_practice_id": "1959418",
      "ehr_provider_id": "26",
      "environment": "dev",
      "health_concierge_enabled": true,
      "id": "example-id",
      "is_active": true,
      "is_locked_integration": true,
      "last_modified_date": "2026-04-22T16:25:47.000+0000",
      "name": "Healthcheck Systems Inc.",
      "patient_app_agent_id": "example-patient_app_agent_id",
      "patient_integration": "Athena Health",
      "senaite_id": "example-senaite_id",
      "telehealth_vendor_id": "Healthcheck",
      "tenant_id": "healthcheck",
      "type": "Other",
      "vitals_device_integration": [
        "[\"Impilo\"]"
      ]
    }
  ],
  "campaigns": [
    {
      "description": "A personalized outreach campaign designed to encourage timely breast cancer screening through education, reminders, and ",
      "end_date": "+15555550123",
      "environment": "dev",
      "healthcare_organization": "example-healthcare_organization",
      "healthcare_organization_name": "Quest Diagnostics Incorporated",
      "id": "example-id",
      "name": "Breast Cancer Screening",
      "phone_agents": [],
      "phone_agents_ids": [
        "[\"56586f9bd0e84cdfa8ed3b705d56ec8d\"]"
      ],
      "start_date": "+15555550123",
      "status": "ACTIVE",
      "tenant_id": "example-tenant_id",
      "type": "Healthcheck Patient Engegement"
    }
  ],
  "segments": [
    {
      "campaign": "example-campaign",
      "campaign_name": "Breast Cancer Screening",
      "category": "example-category",
      "category_name": "Patient Engagement",
      "environment": "dev",
      "filters": {
        "exclude_filters": {
          "age": {
            "max": 50,
            "min": 5
          },
          "alcohol": false,
          "cannabis": false,
          "cocaine": false,
          "conditions": [],
          "gender": [
            "M"
          ],
          "medications": [],
          "procedures": [],
          "smokes": false
        },
        "include_filters": {
          "age": {
            "max": 65,
            "min": 18
          },
          "alcohol": true,
          "cannabis": true,
          "cocaine": false,
          "conditions": [
            {}
          ],
          "gender": [
            "F"
          ],
          "medications": [],
          "procedures": [
            {}
          ],
          "smokes": false
        }
      },
      "healthcare_organization": "example-healthcare_organization",
      "healthcare_organization_name": "Quest Diagnostics Incorporated",
      "id": "example-id",
      "name": "Breast Cancer Screening Default",
      "tenant_id": "example-tenant_id"
    }
  ]
}
```

## 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 { SalesforceGetConfigurationRequest } 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).getConfiguration(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/get-configuration'
```

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