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

> List the workspaces in your Gong company with their details. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

List the workspaces in your Gong company with their details.

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

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

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute gong_list_workspaces --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",
    "workspaces": [
      {
        "id": "id_123",
        "name": "Example",
        "description": "Example description"
      }
    ]
  }
}
```

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

## Input reference

Returns a list of all workspaces including their details. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:workspaces: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": "Returns a list of all workspaces including their details. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:workspaces: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.workspaces` | `array` | No | — | A list, in which each item provides a workspace metadata. |
| `result.data.workspaces[].id` | `string` | No | — | Gong's unique numeric identifier for the workspace (up to 20 digits). |
| `result.data.workspaces[].name` | `string` | No | — | The name of the workspace. |
| `result.data.workspaces[].description` | `string` | No | — | The description of the workspace. |
| `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."
          },
          "workspaces": {
            "type": "array",
            "description": "A list, in which each item provides a workspace metadata.",
            "items": {
              "type": "object",
              "description": "A list, in which each item provides a workspace metadata.",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Gong's unique numeric identifier for the workspace (up to 20 digits)."
                },
                "name": {
                  "type": "string",
                  "description": "The name of the workspace."
                },
                "description": {
                  "type": "string",
                  "description": "The description of the workspace."
                }
              },
              "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.