# Return Salesforce metadata for an arbitrary sobject

Operation ID: `connectors.salesforceDescribe`

Return Salesforce metadata for an arbitrary sobject. Calls Salesforce through the HealthCloud connector gateway.

## Public method

`describe`

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

Return type: `Promise<SalesforceDescribeResult>`

## Authentication

Classification: **AUTHENTICATED**

Schemes: `bearerAuth`

## Prerequisites

None documented.

## HTTP

`POST /connectors/salesforce/describe`

## Path parameters

None.

## Query parameters

None.

## Body parameters

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

Request model: [`SalesforceDescribeRequest`](../models/SalesforceDescribeRequest.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",
  "sobject": "Account",
  "username": "patient@example.com"
}
```

## Success responses

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

## Success response examples

### 200

```json
{
  "actionOverrides": [],
  "activateable": false,
  "childRelationships": [
    {
      "cascadeDelete": true,
      "childSObject": "AIInsightValue",
      "deprecatedAndHidden": false,
      "field": "example-field",
      "junctionIdListNames": [],
      "junctionReferenceTo": [],
      "restrictedDelete": false
    }
  ],
  "compactLayoutable": true,
  "createable": true,
  "custom": false,
  "customSetting": false,
  "deepCloneable": false,
  "deletable": true,
  "deprecatedAndHidden": false,
  "feedEnabled": true,
  "fields": [
    {
      "aggregatable": true,
      "aiPredictionField": false,
      "autoNumber": false,
      "byteLength": 18,
      "calculated": false,
      "cascadeDelete": false,
      "caseSensitive": false,
      "createable": false,
      "custom": false,
      "defaultedOnCreate": true,
      "dependentPicklist": false,
      "deprecatedAndHidden": false,
      "digits": 0,
      "displayLocationInDecimal": false,
      "encrypted": false,
      "externalId": false,
      "filterable": true,
      "formulaTreatNullNumberAsZero": false,
      "groupable": true,
      "highScaleNumber": false,
      "htmlFormatted": false,
      "idLookup": true,
      "label": "Account ID",
      "length": 18,
      "name": "Id",
      "nameField": false,
      "namePointing": false,
      "nillable": false,
      "permissionable": false,
      "picklistValues": [],
      "precision": 0,
      "queryByDistance": false,
      "referenceTo": [],
      "restrictedDelete": false,
      "restrictedPicklist": false,
      "scale": 0,
      "searchPrefilterable": false,
      "soapType": "tns:ID",
      "sortable": true,
      "type": "id",
      "unique": false,
      "updateable": false,
      "writeRequiresMasterRead": false
    }
  ],
  "hasSubtypes": false,
  "isInterface": false,
  "isSubtype": false,
  "label": "Account",
  "labelPlural": "Accounts",
  "layoutable": true,
  "mergeable": true,
  "mruEnabled": true,
  "name": "Account",
  "namedLayoutInfos": [],
  "queryable": true,
  "recordTypeInfos": [
    {
      "active": true,
      "available": true,
      "defaultRecordTypeMapping": true,
      "developerName": "Master",
      "master": true,
      "name": "Master",
      "recordTypeId": "example-recordTypeId",
      "urls": {
        "layout": "/services/data/v59.0/sobjects/Account/describe/layouts/012000000000000AAA"
      }
    }
  ],
  "replicateable": true,
  "retrieveable": true,
  "searchLayoutable": true,
  "searchable": true,
  "sobjectDescribeOption": "FULL",
  "supportedScopes": [
    {
      "label": "All accounts",
      "name": "everything"
    }
  ],
  "triggerable": true,
  "undeletable": true,
  "updateable": true,
  "urls": {
    "approvalLayouts": "/services/data/v59.0/sobjects/Account/describe/approvalLayouts",
    "compactLayouts": "/services/data/v59.0/sobjects/Account/describe/compactLayouts",
    "describe": "/services/data/v59.0/sobjects/Account/describe",
    "layouts": "/services/data/v59.0/sobjects/Account/describe/layouts",
    "listviews": "/services/data/v59.0/sobjects/Account/listviews",
    "quickActions": "/services/data/v59.0/sobjects/Account/quickActions",
    "rowTemplate": "/services/data/v59.0/sobjects/Account/{ID}",
    "sobject": "/services/data/v59.0/sobjects/Account",
    "uiDetailTemplate": "https://healthcheck2-dev-ed.develop.my.salesforce.com/{ID}",
    "uiEditTemplate": "https://healthcheck2-dev-ed.develop.my.salesforce.com/{ID}/e",
    "uiNewRecord": "https://healthcheck2-dev-ed.develop.my.salesforce.com/001/e"
  }
}
```

## 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 { SalesforceDescribeRequest } 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",
  "sobject": "Account",
  "username": "patient@example.com"
};

const result = await connectors.salesforce.createClient(config).describe(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","sobject":"Account","username":"patient@example.com"}' \
  'https://dev-api-connectors.health.cloud/connectors/salesforce/describe'
```

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