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

# Gong: Get CRM Objects

> Get the CRM records you uploaded to a custom Gong CRM integration by their CRM IDs. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

Get the CRM records you uploaded to a custom Gong CRM integration by their CRM IDs.

> [!NOTE]
>
> Tool ID: `gong_get_crm_objects`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'gong_get_crm_objects',
  {
    "integrationId": 123,
    "objectType": "ACCOUNT",
    "objectsCrmIds": [
      "objects_crm_123"
    ]
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute gong_get_crm_objects --input '{
  "integrationId": 123,
  "objectType": "ACCOUNT",
  "objectsCrmIds": [
    "objects_crm_123"
  ]
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "requestId": "request_123",
    "crmObjectsMap": {}
  }
}
```

Use `deepline describe gong_get_crm_objects --json` for the latest machine-readable contract.

## Input reference

This API is for use in the development phase only , to manually verify that objects are uploaded and processed correctly in Gong. Returns a JSON object where each key is the object’s crm id and the corresponding value is a nested JSON object representing the CRM object fields. Each key in the nested JSON is the field name and the corresponding value is the field value. The objects are fetched from the Gong main DB. If the object is not found, the JSON’s value is null. The request body contains an array of objects ids. The request is limited to 100 objects. If more than 100 objects are requested only the first 100 are returned. When accessed using a bearer token, this endpoint requires the 'api:crm:get-objects' scope. Example Request GET [https://api.gong.io/v2/crm/entities?integrationId=6286478263646\&objectType=DEAL](https://api.gong.io/v2/crm/entities?integrationId=6286478263646\&objectType=DEAL) \["1234","8765"] //request body

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.integrationId` | `integer` | Yes | — | Integration ID generated when creating the integration Format: `int64`. |
| `payload.objectType` | `"ACCOUNT" \| "CONTACT" \| "DEAL" \| "LEAD"` | Yes | — | Requested objects type Allowed: `ACCOUNT`, `CONTACT`, `DEAL`, `LEAD`. |
| `payload.objectsCrmIds` | `array` | Yes | — | Request Body: The requested objects crm ids (should be sent in the request body) Items must be unique. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": ".public-api-info { background: rgb(222, 235, 255);}.public-api-tip { background: rgb(227, 252, 239);}.public-api-parameter { background: rgba(9,30,66,0.08);}.public-api-note { background: rgb(234, 230, 255);}.public-api-important { background: rgb(255, 250, 230);}.public-api-critical { background: rgb(255, 235, 230);}table, th, td { border: 1px solid gray; border-collapse: collapse;}th, td { padding: 5px;}th { text-align: left;}img { border: 2px solid #D3D5D9;} This API is for use in the development phase only , to manually verify that objects are uploaded and processed correctly in Gong. Returns a JSON object where each key is the object’s crm id and the corresponding value is a nested JSON object representing the CRM object fields. Each key in the nested JSON is the field name and the corresponding value is the field value. The objects are fetched from the Gong main DB. If the object is not found, the JSON’s value is null. The request body contains an array of objects ids. The request is limited to 100 objects. If more than 100 objects are requested only the first 100 are returned. When accessed using a bearer token, this endpoint requires the 'api:crm:get-objects' scope. Example Request GET https://api.gong.io/v2/crm/entities?integrationId=6286478263646&objectType=DEAL [\"1234\",\"8765\"] //request body",
    "properties": {
      "integrationId": {
        "type": "integer",
        "description": "Integration ID generated when creating the integration",
        "format": "int64"
      },
      "objectType": {
        "type": "string",
        "description": "Requested objects type",
        "enum": [
          "ACCOUNT",
          "CONTACT",
          "DEAL",
          "LEAD"
        ]
      },
      "objectsCrmIds": {
        "type": "array",
        "description": "Request Body: The requested objects crm ids (should be sent in the request body)",
        "uniqueItems": true,
        "items": {
          "type": "string"
        }
      }
    },
    "required": [
      "integrationId",
      "objectType",
      "objectsCrmIds"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.requestId` | `string` | No | — | A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes. |
| `result.data.crmObjectsMap` | `record` | No | — | crmObjects |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

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

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "requestId": {
            "type": "string",
            "description": "A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes."
          },
          "crmObjectsMap": {
            "type": "object",
            "description": "crmObjects",
            "additionalProperties": {
              "type": "object",
              "description": "crmObjects",
              "additionalProperties": {
                "type": "object",
                "description": "crmObjects"
              }
            }
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

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

## Related documentation

* [Gong provider guide](https://deepline.com/docs/providers/gong/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.