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

> List the AI brief templates set up in Gong, for all workspaces or one. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

List the AI brief templates set up in Gong, for all workspaces or one.

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

## 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_briefs',
  {
    "workspaceId": "workspace_123"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute gong_list_briefs --input '{
  "workspaceId": "workspace_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",
    "briefs": [
      {
        "briefId": "brief_123",
        "briefName": "Example",
        "workspaceId": "workspace_123"
      }
    ]
  }
}
```

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

## Input reference

Retrieves settings of all AI briefs in the system or in a specified workspace. Required authorization scope: 'api:ai-briefer:read'.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.workspaceId` | `string` | No | — | The ID of the workspace the AI briefs are in. When empty, all briefs in all workspaces are returned. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Retrieves settings of all AI briefs in the system or in a specified workspace. Required authorization scope: 'api:ai-briefer:read'.",
    "properties": {
      "workspaceId": {
        "type": "string",
        "description": "The ID of the workspace the AI briefs are in. When empty, all briefs in all workspaces are returned."
      }
    },
    "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.briefs` | `array` | No | — | A list of AI briefs. |
| `result.data.briefs[].briefId` | `string` | No | — | The unique identifier of the brief. |
| `result.data.briefs[].briefName` | `string` | No | — | The name of the brief. |
| `result.data.briefs[].workspaceId` | `string` | No | — | The id of the workspace the brief is in. |
| `result.data.briefs[].description` | `string` | No | — | The description of the brief. |
| `result.data.briefs[].status` | `string` | No | — | Indicates whether the brief is published. Options are: "Published", "Not published". |
| `result.data.briefs[].creator` | `string` | No | — | The name of the team member who created the brief. |
| `result.data.briefs[].creatorUserId` | `string` | No | — | The id of the team member who created the brief. |
| `result.data.briefs[].created` | `string` | No | — | The date and time the brief 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. |
| `result.data.briefs[].updated` | `string` | No | — | The date and time the brief was last 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. |
| `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."
          },
          "briefs": {
            "type": "array",
            "description": "A list of AI briefs.",
            "items": {
              "type": "object",
              "description": "AI Brief settings",
              "properties": {
                "briefId": {
                  "type": "string",
                  "description": "The unique identifier of the brief."
                },
                "briefName": {
                  "type": "string",
                  "description": "The name of the brief."
                },
                "workspaceId": {
                  "type": "string",
                  "description": "The id of the workspace the brief is in."
                },
                "description": {
                  "type": "string",
                  "description": "The description of the brief."
                },
                "status": {
                  "type": "string",
                  "description": "Indicates whether the brief is published. Options are: \"Published\", \"Not published\"."
                },
                "creator": {
                  "type": "string",
                  "description": "The name of the team member who created the brief."
                },
                "creatorUserId": {
                  "type": "string",
                  "description": "The id of the team member who created the brief."
                },
                "created": {
                  "type": "string",
                  "description": "The date and time the brief 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."
                },
                "updated": {
                  "type": "string",
                  "description": "The date and time the brief was last 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."
                }
              },
              "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.