Gong: List Briefs

Retrieve AI brief settings (/v2/settings/briefs).

Tool ID: gong_list_briefs

Run this action

Use the TypeScript SDK for a single call. Put ctx.tools.execute(...) inside a Play when the call should be durable, scheduled, or run across a CSV.

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

deepline tools execute gong_list_briefs --input '{
  "workspaceId": "workspace_123"
}' --json

Example response

The SDK exposes this shape at result.toolResponse.raw. Values below are representative.

{
  "data": {
    "requestId": "request_123",
    "briefs": [
      {
        "briefId": "brief_123",
        "briefName": "Example",
        "workspaceId": "workspace_123"
      }
    ]
  }
}

Use deepline tools get 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.

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

Deepline cost

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

Get started

Build and automate

Common workflows

Data and integrations

Reference

Gong: List Briefs

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation