> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Salesforce Fetch Fields: Inputs, Cost & CLI Example

> Inspect Salesforce field metadata and validation rules before writing. Includes inputs, outputs, costs, and Deepline CLI examples for GTM automation.

## Run in Enrichment Spreadsheet

<Info>
  Use this function as a column step in `deepline enrich`.
</Info>

```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=salesforce_fetch_fields:{}' --json
```

<Tip>
  Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
</Tip>

## Input Schema

| Name           | Type     | Required | Default | Description                                                  |
| -------------- | -------- | -------- | ------- | ------------------------------------------------------------ |
| `payload.name` | `string` | No       |         | Salesforce object API name. Defaults to "Task" when omitted. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Fetch Salesforce field metadata, child relationships, and validation rules.",
    "properties": {
      "name": {
        "type": "string",
        "description": "Salesforce object API name. Defaults to \"Task\" when omitted."
      }
    },
    "additionalProperties": false
  }
  ```
</details>

## Output Schema

| Name          | Type     | Required | Default | Description                                    |
| ------------- | -------- | -------- | ------- | ---------------------------------------------- |
| `result.data` | `object` | Yes      |         | Provider response payload.                     |
| `result.meta` | `record` | No       |         | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "fields": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string"
                },
                "label": {
                  "type": "string"
                },
                "type": {
                  "type": "string"
                },
                "referenceTo": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                "relationshipName": {
                  "anyOf": [
                    {
                      "type": "string"
                    },
                    {}
                  ]
                }
              },
              "required": [
                "name",
                "label",
                "type",
                "referenceTo",
                "relationshipName"
              ],
              "additionalProperties": false
            }
          },
          "childRelationships": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "object": {
                  "type": "string"
                },
                "relationshipName": {
                  "anyOf": [
                    {
                      "type": "string"
                    },
                    {}
                  ]
                },
                "field": {
                  "type": "string"
                }
              },
              "required": [
                "object",
                "relationshipName",
                "field"
              ],
              "additionalProperties": false
            }
          },
          "validationRules": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "errorConditionFormula": {
                  "type": "string"
                },
                "errorMessage": {
                  "type": "string"
                }
              },
              "required": [
                "id",
                "name",
                "errorConditionFormula",
                "errorMessage"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "fields",
          "childRelationships",
          "validationRules"
        ],
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": {}
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Advanced: Direct CLI

<Info>
  Use direct execution for single payload debugging.
</Info>

```bash theme={null}
deepline tools execute salesforce_fetch_fields --payload '{}' --json
```

### CLI flags

| Flag                        | Description                                         |
| --------------------------- | --------------------------------------------------- |
| `--json`                    | Print machine-readable output.                      |
| `--wait`                    | Wait for terminal provider status when supported.   |
| `--debug`                   | Enable wait mode with additional status/log output. |
| `--wait-timeout SECONDS`    | Max seconds to wait in wait mode.                   |
| `--poll-interval SECONDS`   | Polling interval in seconds during wait mode.       |
| `--timeout SECONDS`         | Request timeout in seconds.                         |
| `--connect-timeout SECONDS` | Connection timeout in seconds.                      |

## Cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.
* Billing mode: `no_bill`.
