> ## 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: List Scorecards

> List the call scorecards set up in Gong with their questions. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

List the call scorecards set up in Gong with their questions.

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

## 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_list_scorecards',
  {},
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute gong_list_scorecards --input '{}' --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",
    "scorecards": [
      {
        "scorecardId": 123,
        "scorecardName": "Example",
        "workspaceId": 123
      }
    ]
  }
}
```

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

## Input reference

Retrieve all the scorecards within the Gong system. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:settings:scorecards:read'.

This action requires no input fields.

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Retrieve all the scorecards within the Gong system. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:settings:scorecards:read'.",
    "properties": {},
    "required": [],
    "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.scorecards` | `array` | No | — | A list, in which each item contains one scorecard. |
| `result.data.scorecards[].scorecardId` | `integer` | No | — | The identifier of the scorecard. Format: `int64`. |
| `result.data.scorecards[].scorecardName` | `string` | No | — | Scorecard name. |
| `result.data.scorecards[].workspaceId` | `integer` | No | — | Scorecard workspaceId. Format: `int64`. |
| `result.data.scorecards[].enabled` | `boolean` | No | — | If the scorecard is enabled or not. |
| `result.data.scorecards[].updaterUserId` | `integer` | No | — | The user Id of the team member that updated the scorecard. Format: `int64`. |
| `result.data.scorecards[].created` | `string` | No | — | The date and time when the scorecard was created in the ISO-8601 format, for example: '2024-01-17T16:20:05-03:00' or '2016-02-16T03:57:04.834+05:30' or '2020-11-20T21:30:07.233692Z', where Z stands for UTC. Format: `date-time`. |
| `result.data.scorecards[].updated` | `string` | No | — | The date and time when the scorecard was updated in the ISO-8601 format, for example: '2024-01-17T16:20:05-03:00' or '2016-02-16T03:57:04.834+05:30' or '2020-11-20T21:30:07.233692Z', where Z stands for UTC. Format: `date-time`. |
| `result.data.scorecards[].reviewMethod` | `"AUTOMATIC" \| "MANUAL"` | No | — | The method used to review the scorecard. Allowed: `AUTOMATIC`, `MANUAL`. |
| `result.data.scorecards[].questions` | `array` | No | — | The questions in the scorecard. |
| `result.data.scorecards[].questions[].questionId` | `integer` | No | — | The identifier for the question. Format: `int64`. |
| `result.data.scorecards[].questions[].questionRevisionId` | `integer` | No | — | The identifier for the revision version of the question. Format: `int64`. |
| `result.data.scorecards[].questions[].questionText` | `string` | No | — | The question's text. |
| `result.data.scorecards[].questions[].isOverall` | `boolean` | No | — | If the question is the main overall question. |
| `result.data.scorecards[].questions[].questionType` | `string` | No | — | The type of question. |
| `result.data.scorecards[].questions[].answerGuide` | `string` | No | — | The guide for answering the question. |
| `result.data.scorecards[].questions[].minRange` | `integer` | No | — | The minimum value that can be selected in the answer. Null for questions with no range. Format: `int32`. |
| `result.data.scorecards[].questions[].maxRange` | `integer` | No | — | The maximum value that can be selected in the answer. Null for questions with no range. Format: `int32`. |
| `result.data.scorecards[].questions[].answerOptions` | `array` | No | — | The answer options in case of multi-select or single-select type question. Null otherwise. |
| `result.data.scorecards[].questions[].answerOptions[].id` | `integer` | No | — | The identifier of the option. Format: `int32`. |
| `result.data.scorecards[].questions[].answerOptions[].text` | `string` | No | — | The option’s text. |
| `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."
          },
          "scorecards": {
            "type": "array",
            "description": "A list, in which each item contains one scorecard.",
            "items": {
              "type": "object",
              "description": "A list, in which each item contains one scorecard.",
              "properties": {
                "scorecardId": {
                  "type": "integer",
                  "description": "The identifier of the scorecard.",
                  "format": "int64"
                },
                "scorecardName": {
                  "type": "string",
                  "description": "Scorecard name."
                },
                "workspaceId": {
                  "type": "integer",
                  "description": "Scorecard workspaceId.",
                  "format": "int64"
                },
                "enabled": {
                  "type": "boolean",
                  "description": "If the scorecard is enabled or not."
                },
                "updaterUserId": {
                  "type": "integer",
                  "description": "The user Id of the team member that updated the scorecard.",
                  "format": "int64"
                },
                "created": {
                  "type": "string",
                  "description": "The date and time when the scorecard was created in the ISO-8601 format, for example: '2024-01-17T16:20:05-03:00' or '2016-02-16T03:57:04.834+05:30' or '2020-11-20T21:30:07.233692Z', where Z stands for UTC.",
                  "format": "date-time"
                },
                "updated": {
                  "type": "string",
                  "description": "The date and time when the scorecard was updated in the ISO-8601 format, for example: '2024-01-17T16:20:05-03:00' or '2016-02-16T03:57:04.834+05:30' or '2020-11-20T21:30:07.233692Z', where Z stands for UTC.",
                  "format": "date-time"
                },
                "reviewMethod": {
                  "type": "string",
                  "description": "The method used to review the scorecard.",
                  "enum": [
                    "AUTOMATIC",
                    "MANUAL"
                  ]
                },
                "questions": {
                  "type": "array",
                  "description": "The questions in the scorecard.",
                  "items": {
                    "type": "object",
                    "description": "The questions in the scorecard.",
                    "properties": {
                      "questionId": {
                        "type": "integer",
                        "description": "The identifier for the question.",
                        "format": "int64"
                      },
                      "questionRevisionId": {
                        "type": "integer",
                        "description": "The identifier for the revision version of the question.",
                        "format": "int64"
                      },
                      "questionText": {
                        "type": "string",
                        "description": "The question's text."
                      },
                      "isOverall": {
                        "type": "boolean",
                        "description": "If the question is the main overall question."
                      },
                      "questionType": {
                        "type": "string",
                        "description": "The type of question."
                      },
                      "answerGuide": {
                        "type": "string",
                        "description": "The guide for answering the question."
                      },
                      "minRange": {
                        "type": "integer",
                        "description": "The minimum value that can be selected in the answer. Null for questions with no range.",
                        "format": "int32"
                      },
                      "maxRange": {
                        "type": "integer",
                        "description": "The maximum value that can be selected in the answer. Null for questions with no range.",
                        "format": "int32"
                      },
                      "answerOptions": {
                        "type": "array",
                        "description": "The answer options in case of multi-select or single-select type question. Null otherwise.",
                        "items": {
                          "type": "object",
                          "description": "The answer options in case of multi-select or single-select type question. Null otherwise.",
                          "properties": {
                            "id": {
                              "type": "integer",
                              "description": "The identifier of the option.",
                              "format": "int32"
                            },
                            "text": {
                              "type": "string",
                              "description": "The option’s text."
                            }
                          },
                          "additionalProperties": false
                        }
                      }
                    },
                    "additionalProperties": false
                  }
                }
              },
              "additionalProperties": false
            }
          }
        },
        "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.