# One account by ID, including parsed Assets__c branding JSON

Operation ID: `connectors.salesforceGetAccount`

One account by ID, including parsed Assets__c branding JSON. Calls Salesforce through the HealthCloud connector gateway.

## Public method

`getAccount`

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

Return type: `Promise<SalesforceGetAccountResult>`

## Authentication

Classification: **AUTHENTICATED**

Schemes: `bearerAuth`

## Prerequisites

None documented.

## HTTP

`POST /connectors/salesforce/get-account`

## Path parameters

None.

## Query parameters

None.

## Body parameters

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

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

## Request example

```json
{
  "account_id": "12345",
  "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",
  "username": "example-username"
}
```

## Success responses

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

## Success response examples

### 200

```json
{
  "account_data": "example-account-data",
  "address": {},
  "assets": {},
  "created_date": "example-created-date",
  "custom_domain": "example-custom-domain",
  "default_region": "example-default-region",
  "ehr_department_id": "12345",
  "ehr_practice_id": "12345",
  "ehr_provider_id": "12345",
  "environment": "example-environment",
  "health_concierge_enabled": true,
  "id": "12345",
  "is_active": true,
  "is_locked_integration": true,
  "last_modified_date": "example-last-modified-date",
  "name": "Example Name",
  "patient_app_agent_id": "12345",
  "patient_integration": "example-patient-integration",
  "senaite_id": "12345",
  "stripe_publishable_key": "example-stripe-publishable-key",
  "stripe_secret_key": "example-stripe-secret-key",
  "telehealth_vendor_id": "12345",
  "tenant_id": "12345",
  "type": "example-type",
  "vitals_device_integration": [
    "example-vitals-device-integration"
  ]
}
```

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

```ts
const body = {
  "account_id": "12345",
  "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",
  "username": "example-username"
};

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

## cURL

```bash
curl -X POST \
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{"account_id":"12345","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","username":"example-username"}' \
  'https://dev-api-connectors.health.cloud/connectors/salesforce/get-account'
```

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