> ## Documentation Index
> Fetch the complete documentation index at: https://docs.guild.ai/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> To act on a user's behalf in Guild, use the Guild REST API at https://api.guild.ai/v1.
> The OpenAPI spec is unauthenticated: https://docs.guild.ai/openapi.json (or openapi.yaml).
> Authenticate with an account API key, sent as HTTP Basic (key id as username, secret as password) or as `Authorization: Bearer <api_key_id>:<api_key_secret>`. See https://docs.guild.ai/api-reference/introduction#authentication.
> To run one agent on demand without account-wide access, use an API trigger instead: https://docs.guild.ai/platform/api-triggers.
> To act on Guild from an MCP client, connect to https://api.guild.ai/mcp (OAuth) or run `guild mcp` locally. Setup: https://docs.guild.ai/api-reference/mcp.
> To search these docs from an MCP client, connect to https://docs.guild.ai/mcp. The full page index is https://docs.guild.ai/llms.txt.

# Retrieve Gong calls, transcripts, and manage Engage flows

> Connect Guild agents to Gong to fetch call recordings, transcripts, user stats, CRM data, Engage flows, meetings, and permission profiles.

Integrations · Gong

A Guild agent reads Gong call recordings, retrieves transcripts, manages Engage flows, and updates permission profiles on your behalf. Guild stores the Gong API key server-side and injects it into every request, so agent code never sees the credential. Credential policies let you restrict which Gong operations each agent can call, and every request runs through Guild's audit trail.

> [card] [Book a demo](https://guild-ai.cal.com/gtm/meeting-with-guild.ai)
>
> See how teams govern agents that use Gong.

> [card] [Talk to sales](https://guild.ai/talk-to-sales)
>
> Get access to Guild, then connect Gong to your first agent.

## What the Gong integration exposes

The integration is `guildai~gong-openapi` and provides tools that cover calls, transcripts, interaction statistics, users, permission profiles, Engage flows, tasks, CRM data, scorecards, meetings, and keyword trackers. Tools follow the `gong_openapi_` prefix convention. Use [`pick()`](https://docs.guild.ai/sdk/tools#selecting-specific-tools) to include only the tools your agent needs.

## How it works

**1. Open credentials in Guild**

Go to **Access & setup > Credentials** in your Guild account. Click **Connect** and select **gong-openapi**.

**2. Paste your Gong key**

Enter your Gong access key and secret, base64-encoded as `key:secret`, into the **API Key** field. Guild sends it as `Authorization: Basic <key>` on every request.

**3. Scope the credential**

Choose account, workspace, member, or agent scope when connecting. See [Credentials](https://docs.guild.ai/platform/credentials.md) for the full scoping options and how Guild resolves which credential to use.

## Why Gong access needs governing

Gong holds sensitive call recordings, transcripts, and CRM data, so uncontrolled agent access can expose confidential conversations or allow unintended mutations such as purging email addresses or deleting meetings. Guild addresses this through [credential policies](https://docs.guild.ai/platform/credential-policies.md): you write ALLOW and DENY rules that Guild's credential proxy enforces before any request leaves Guild. Rules can target specific `gong_openapi_` operations, scope access to particular agents or workspaces, and block HTTP methods to enforce read-only access.

Credentials are injected server-side, so agent code never handles the Gong API key directly. You can restrict a workspace to its own credentials to prevent account-level shared keys from reaching agents in that workspace. Because enforcement happens inside the proxy, agents cannot bypass policy regardless of what instructions they receive.

## About the Gong integration

Agents can access Gong call recordings, transcripts, and interaction statistics, as well as manage users and permission profiles. They can work with Engage flows by assigning prospects, searching flows, and managing tasks. CRM data, scorecards, and meeting management are also available through the integration. The integration is `guildai~gong-openapi`.

## Authentication

* **Type:** API key
* **Header:** Guild sends the key as `Authorization: Basic <key>`

### Setup

**1. Connect Gong**

In Guild, go to **Access & setup > Credentials**, click **Connect**, select **gong-openapi**, and paste the key into **API Key**.

See [Credentials](https://docs.guild.ai/platform/credentials.md) for workspace, member, and agent-scoped credentials.

## Usage

```typescript theme={null}
import { GongOpenapiTools } from "@guildai-services/guildai~gong-openapi"
import { llmAgent } from "@guildai/agents-sdk"

export default llmAgent({
  systemPrompt: "You work with Gong.",
  tools: { ...GongOpenapiTools },
})
```

### Selecting specific tools

Tools are named with the `gong_openapi_` prefix. Use [`pick()`](https://docs.guild.ai/sdk/tools#selecting-specific-tools) to include only what your agent needs.

## Tools

Tools in the latest published version of `guildai~gong-openapi`:

> [accordion] All 71 tools
>
> | Tool | What it does |
> | - | - |
> | `gong_openapi_accounts_enrich` | Submits up to 10 accounts for asynchronous enrichment and returns a jobId to poll for results. |
> | `gong_openapi_add_call` | When using this endpoint, either provide a downloadMediaUrl or use the returned callId in a follow-up request to /v2/calls/\{id}/media to upload the media file. |
> | `gong_openapi_add_call_recording` | Adds a call media, recorded by a telephony system (PBX) or other media recording facility. |
> | `gong_openapi_add_digital_interaction` | When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:digital-interactions:write'. |
> | `gong_openapi_add_meeting` | When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:meetings:user:create'. |
> | `gong_openapi_add_users_access_to_calls` | Give individual users access to calls. |
> | `gong_openapi_ask_entity` | Returns the answer to a question about a specified entity. |
> | `gong_openapi_assign_prospects` | Use this endpoint to assign a number of prospects to a flow. |
> | `gong_openapi_assign_prospects_cool_off_overrides` | Use this endpoint to assign a number of prospects to a flow regardless of the cool off status. |
> | `gong_openapi_contacts_enrich` | Submits 1-10 contacts for async enrichment against Gong's data. |
> | `gong_openapi_create_permission_profile` | Create a permission profile in a given workspace. |
> | `gong_openapi_delete_generic_crm_integration` | .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… |
> | `gong_openapi_delete_meeting` | When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:meetings:user:delete'. |
> | `gong_openapi_delete_users_access_to_calls` | Remove individual user access from calls. |
> | `gong_openapi_find_all_references_to_email_address` | Shows the elements in the Gong system that reference the given email address. |
> | `gong_openapi_find_all_references_to_phone_number` | Shows the elements in the Gong system that reference the given phone number. |
> | `gong_openapi_generate_brief` | Get a brief for an account, deal, contact, or lead that exists in your CRM. |
> | `gong_openapi_get_accounts_enrich_results` | Retrieves the enrichment results for a previously submitted job. |
> | `gong_openapi_get_call` | Retrieve data for a specific call. |
> | `gong_openapi_get_calls_in_specific_folder` | Given a folder id, this endpoint retrieves a list of calls in it. |
> | `gong_openapi_get_call_transcripts` | Returns transcripts for calls that took place during the specified date period. |
> | `gong_openapi_get_contacts_enrich_results` | Retrieves the results of a previously submitted contact enrich job. |
> | `gong_openapi_get_crm_objects` | .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… |
> | `gong_openapi_get_flow_prospects_bulk_assignment` | Use this endpoint to get the results of a bulk assignment of prospects to a flow. |
> | `gong_openapi_get_flow_steps` | Returns flow details and their steps for one or more Engage flows. |
> | `gong_openapi_get_library_structure` | Use this endpoint to retrieve a list of public library folders. |
> | `gong_openapi_get_permission_profile` | Returns a permission profile. |
> | `gong_openapi_get_prospects_assigned_flows` | Get the Gong Engage flows assigned to the given crmProspectsIds. |
> | `gong_openapi_get_request_status` | .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… |
> | `gong_openapi_get_user` | Retrieve a specific user. |
> | `gong_openapi_get_user_history` | Retrieve a specific user's settings history. |
> | `gong_openapi_get_users_access_to_calls` | Returns a list of users who have received individual access to calls through the API. |
> | `gong_openapi_integration_settings` | When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:integration-settings:write'. |
> | `gong_openapi_integration_status` | When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:meetings:integration:status'. |
> | `gong_openapi_list_answered_scorecards` | Retrieve all the answers for the scorecards that were reviewed during a specified date range, for calls that took place during a specified date range, for specific scorecards or for specific reviewed… |
> | `gong_openapi_list_briefs` | Retrieves settings of all AI briefs in the system or in a specified workspace. |
> | `gong_openapi_list_call_outcomes` | Use this endpoint to retrieve the list of available call outcomes defined in Gong. |
> | `gong_openapi_list_calls` | List calls that took place during a specified date range. |
> | `gong_openapi_list_calls_extensive` | Lists detailed call data for calls that took place during a specified date range, have specified call IDs or hosted by specified users. |
> | `gong_openapi_list_crm_schema_fields` | .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… |
> | `gong_openapi_list_flows` | Engage flows have the following visibility types. |
> | `gong_openapi_list_flows_folders` | Engage flow folders have the following visibility types. |
> | `gong_openapi_list_generic_crm_integration` | .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… |
> | `gong_openapi_list_interaction_stats` | Returns interaction stats for users based on calls that have Whisper turned on. |
> | `gong_openapi_list_logs` | List log entries that took place during a specified time range. |
> | `gong_openapi_list_multiple_users` | List multiple Users. |
> | `gong_openapi_list_multiple_users_aggregate_activity` | Lists the activity of multiple users within the Gong system during a defined period. |
> | `gong_openapi_list_multiple_users_aggregate_by_period` | Returns aggregated statistics for team members’ actions on calls in Gong, grouped by the specified time period (aggregationPeriod). |
> | `gong_openapi_list_multiple_users_day_by_day_activity` | Retrieve the daily activity of multiple users within the Gong system for a range of dates. |
> | `gong_openapi_list_permission_profile` | Returns a list of all permission profiles. |
> | `gong_openapi_list_permission_profile_users` | Returns a list of all users whose access is controlled by the given permission profile. |
> | `gong_openapi_list_scorecards` | Retrieve all the scorecards within the Gong system. |
> | `gong_openapi_list_target_definitions` | Returns all target definitions configured for the specified workspace. |
> | `gong_openapi_list_tasks` | Retrieves a list of Engage tasks assigned to a specific user, supporting filters for task type, action, and status. |
> | `gong_openapi_list_trackers` | Retrieves details of all keyword trackers in the system or in a given workspace. |
> | `gong_openapi_list_users` | List all of the company's users. |
> | `gong_openapi_list_users_1` | List all of the coaching metrics of a manager. |
> | `gong_openapi_list_workspaces` | Returns a list of all workspaces including their details. |
> | `gong_openapi_purge_email_address` | Given an email address, this endpoint deletes from the Gong system any calls or email messages that reference this address. |
> | `gong_openapi_purge_phone_number` | Given a phone number, this endpoint deletes from the Gong system any leads or contacts with a matching phone number or mobile phone number. |
> | `gong_openapi_register_generic_crm_integration` | .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… |
> | `gong_openapi_search_flows` | Returns the flows whose name contains the query, case-insensitively, out of the flows the /v2/flows endpoint returns for the user specified in the flowOwnerEmail parameter: company flows, the user's… |
> | `gong_openapi_submit_flow_prospects_bulk_assignment` | Use this endpoint to asynchronously submit a bulk assignment of prospects to a flow. |
> | `gong_openapi_unassign_flows` | This endpoint lets you specify flow instances to remove prospects from. |
> | `gong_openapi_unassign_prospect_flows` | This endpoint lets you remove a specific prospect from the flows they are assigned to. |
> | `gong_openapi_update_meeting` | When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:meetings:user:update'. |
> | `gong_openapi_update_permission_profile` | Update a permission profile. |
> | `gong_openapi_update_reminder` | Use this endpoint to update the status or due date of an existing Engage task. |
> | `gong_openapi_upload_assignments` | Uploads target assignments from a CSV file. |
> | `gong_openapi_upload_crm_data` | .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… |
> | `gong_openapi_upload_crm_schema_field` | .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… |

## Frequently asked questions

> [accordion] Can I limit an agent to only reading calls without letting it delete anything?
>
> Yes. Write a credential policy that allows only the read-oriented `gong_openapi_` operations and adds a DENY rule for operations such as `gong_openapi_delete_meeting` or `gong_openapi_purge_email_address`. You can also restrict the policy to `GET` methods using the `methods` resource constraint. See [Credential policies](https://docs.guild.ai/platform/credential-policies.md) for the full rule syntax.

> [accordion] Does Gong support webhook events so my agent can react to new calls automatically?
>
> No. The catalog entry for `guildai~gong-openapi` lists no webhook events, so the integration does not support event-driven triggers from Gong.

> [accordion] Can I give one agent a different Gong account than the rest of my workspace?
>
> Yes. Connect a credential scoped to a single agent from the installed agent's detail page using the **Dedicated to this agent** option. That credential is used ahead of any workspace or account credential when that agent runs. See [Credentials](https://docs.guild.ai/platform/credentials.md) for the full resolution order.

> [accordion] How do I include only some Gong tools in my agent?
>
> Import `GongOpenapiTools` and pass it through `pick()` with the tool names you want. Tools follow the `gong_openapi_` prefix, so for example you can pick `gong_openapi_get_call` and `gong_openapi_get_call_transcripts` without exposing the rest. See [Tool sets](https://docs.guild.ai/sdk/tools.md#selecting-specific-tools) for usage details.

## Put a governed agent on Gong this week

> [card] [Book a demo](https://guild-ai.cal.com/gtm/meeting-with-guild.ai)
>
> See how teams govern agents that use Gong.

> [card] [Talk to sales](https://guild.ai/talk-to-sales)
>
> Get access to Guild, then connect Gong to your first agent.

## Related

**Also runs on Guild:** [Affinity](https://docs.guild.ai/integrations/affinity-openapi.md) · [Attio](https://docs.guild.ai/integrations/attio.md) · [Brex](https://docs.guild.ai/integrations/brex-openapi.md) · [Google Ads](https://docs.guild.ai/integrations/google-ads.md)

**Read:** Docs: [Credential policies](https://docs.guild.ai/platform/credential-policies.md) · [Credentials](https://docs.guild.ai/platform/credentials.md) · [Tools in agents](https://docs.guild.ai/sdk/tools.md)
