> ## Documentation Index > Fetch the complete documentation index at: https://docs.boxd.sh/llms.txt > Use this file to discover all available pages before exploring further. # Gong > Gong is a platform for video meetings, call recording, and team collaboration Gong is a platform for video meetings, call recording, and team collaboration. `gong` · **58 tools** · no triggers ## Connect it ```bash theme={"theme":"github-dark"} run auth gong run auth gong --scope team # shared with the organization ``` Or from the [Integrations page](https://app.boxd.sh/integrations) in the console. See [Connections](/guides/integrations/connections) for personal versus shared, and who may remove one. ## Use it ```bash theme={"theme":"github-dark"} run gong # common commands run gong --all # every command ``` ```ts theme={"theme":"github-dark"} import { gong } from "@boxd/run"; ``` ## Common tools | Tool | What it does | | ------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `get-call-by-id` | Tool to fetch specific call metadata by call ID. Use when you need to retrieve detailed information about a specific call using Gong's unique identifier. | | `get-call-transcript` | Tool to retrieve call transcripts from Gong. Use when you need to access the text content of calls with speaker information, timestamps, and topic categorization. | | `get-flow-prospects` | Tool to retrieve Gong Engage flows assigned to specified prospects. | | `get-interaction-statistics` | Tool to retrieve interaction trend statistics for users based on calls with Whisper enabled. | | `get-user-by-id` | Tool to retrieve individual user details by user ID. Use when you need to fetch specific user information including profile data, settings, and organizational details. | | `list-call-outcomes` | Tool to retrieve all available call outcomes defined in Gong. | | `list-flow-folders` | Tool to list all Gong Engage flow folders with visibility types. | | `list-scorecards` | Tool to retrieve all scorecards within the Gong system. Use when you need to list all scorecard configurations and their associated assessment questions. | | `list-tasks` | Tool to retrieve Engage tasks assigned to a specific user with filtering options. | | `retrieve-call-data-by-date-range-v2-calls` | List calls that took place during a specified date range. When accessed through a Bearer token authorization method, this endpoint requires the scope... | | `unassign-flows-by-crm-id` | Tool to unassign flows from prospects by their CRM Prospect ID. | | `validate-meeting-integration` | Validates Gong meeting integration status for one or more users by their email addresses. | | Tool | What it does | | ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `add-call-media-v2-calls-id-media` | Adds a call media, recorded by a telephony system (PBX) or other media recording facility. | | `add-new-call-v2-calls` | 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. | | `aggregate-activity-by-period-via-api` | Lists the aggregated activity of multiple users within the Gong system for each time period within the defined date range. | | `aggregate-user-activity-statistics` | Lists the activity of multiple users within the Gong system during a defined period. | | `assign-prospects-to-flow` | Use this endpoint to assign a number of prospects to a flow. | | `create-activity-scorecards-report` | Retrieve all the answers for the scorecards that were reviewed during a specified date range, for calls that took place during a specified date... | | `create-new-meeting-v2-meetings` | When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:meetings:user:create'. | | `create-permission-profile-v2-permission-profile` | Create a permission profile in a given workspace. | | `data-privacy-for-phone-number` | Shows the elements in the Gong system that reference the given phone number. | | `delete-generic-crm-integration-v2-crm-integrations` | Deletes an existing generic CRM integration from the Gong platform. | | `delete-meeting` | Deletes a Gong meeting created via the Meetings API (Beta). Use this to remove a scheduled meeting by providing its unique meeting ID and the organizer's email address. | | `delete-users-from-call-access-list` | Remove individual user access from calls. The request can only remove access previously given by the /v2/calls/users-access API. | | `erase-data-for-email-address` | Erase all data associated with an email address from Gong (GDPR compliance). | | `erase-data-for-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. | | `fetch-all-permission-profiles` | Returns a list of all permission profiles. The listing is in the alphabetical order of the profile names. | | `get-call-by-id` | Tool to fetch specific call metadata by call ID. Use when you need to retrieve detailed information about a specific call using Gong's unique identifier. | | `get-call-transcript` | Tool to retrieve call transcripts from Gong. Use when you need to access the text content of calls with speaker information, timestamps, and topic categorization. | | `get-crm-integration-details` | Retrieves details of generic CRM integrations registered with Gong. | | `get-crm-objects-v2-crm-entities` | Retrieves specific CRM objects by their IDs from Gong's CRM integration. | | `get-flow-prospects` | Tool to retrieve Gong Engage flows assigned to specified prospects. | | `get-interaction-statistics` | Tool to retrieve interaction trend statistics for users based on calls with Whisper enabled. | | `get-permission-profile` | Returns a permission profile. | | `get-request-status-v2-crm-request-status` | The GetCRMRequestStatus endpoint retrieves the current status of CRM integration requests in the Gong platform. | | `get-user-by-id` | Tool to retrieve individual user details by user ID. Use when you need to fetch specific user information including profile data, settings, and organizational details. | | `get-user-settings-history` | Tool to retrieve historical changes to a user's settings. Use when you need to track capability modifications for a specific user identified by their Gong ID. | | `list-all-coaching-metrics-v2-coaching` | List all of the coaching metrics of a manager. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:coaching:read'. | | `list-all-company-workspaces-v2-workspaces` | Returns a list of all workspaces including their details. When accessed through a Bearer token authorization method, this endpoint requires the scope... | | `list-all-users-v2-users` | List all of the company's users. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:users:read'. | | `list-call-outcomes` | Tool to retrieve all available call outcomes defined in Gong. | | `list-flow-folders` | Tool to list all Gong Engage flow folders with visibility types. | | `list-folder-calls` | Given a folder id, this endpoint retrieves a list of calls in it. | | `list-engage-flows-v2-flows` | Engage flows have the following visibility types: \* Company: visible to everyone in the company, can only be edited by users with edit permissions. \*... | | `list-schema-fields-v2-crm-entity-schema` | Retrieves schema fields for a specific CRM object type within a Generic CRM integration. | | `list-scorecards` | Tool to retrieve all scorecards within the Gong system. Use when you need to list all scorecard configurations and their associated assessment questions. | | `list-tasks` | Tool to retrieve Engage tasks assigned to a specific user with filtering options. | | `list-users-by-filter-v2-users-extensive` | List multiple Users. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:users:read'. | | `manage-user-call-access` | Retrieves a list of users who have been granted individual access to specific calls through the API. | | `post-digital-interaction-v2-digital-interaction` | When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:digital-interactions:write'. | | `post-day-by-day-activity-stats` | Retrieve the daily activity of multiple users within the Gong system for a range of dates. | | `register-crm-integration` | Updates an existing CRM integration in the Gong platform. This endpoint allows you to modify the details of a previously set up integration between... | | `report-content-share-event` | Tool to push content share engagement events to Gong's activity timeline. | | `report-content-view-event` | Tool to log content view engagement events to Gong's activity timeline. | | `report-custom-engagement-event` | Report custom engagement events to Gong's activity timeline. | | `retrieve-call-data-by-date-range-v2-calls` | List calls that took place during a specified date range. When accessed through a Bearer token authorization method, this endpoint requires the scope... | | `retrieve-data-privacy-info-for-email-address` | Retrieves data privacy information for a third-party email address. | | `retrieve-filtered-call-details` | Lists detailed call data for calls that took place during a specified date range, have specified call IDs or hosted by specified users. | | `retrieve-library-folders-v2-library-folders` | Use this endpoint to retrieve a list of public library folders. | | `retrieve-logs-data-by-type-and-time-range-v2-logs` | List log entries that took place during a specified time range. | | `retrieve-manual-crm-call-associations` | Returns a list of all calls that were manually associated or re-associated with CRM account and deal/opportunity since a given time. | | `retrieve-tracker-details-v2-settings-trackers` | Retrieves details of all keyword trackers in the system or in a given workspace. | | `retrieve-transcripts-of-calls-v2-calls-transcript` | DEPRECATED: Use GONG\_GET\_CALL\_TRANSCRIPT instead. Returns transcripts for calls that took place during the specified date period. | | `retrieve-users-from-permission-profile` | Returns a list of all users whose access is controlled by the given permission profile. | | `set-user-call-access` | Give individual users access to calls. If a user already has access (perhaps the call was shared with them, or they have access through their... | | `unassign-flows-by-crm-id` | Tool to unassign flows from prospects by their CRM Prospect ID. | | `update-meeting-v2-meetings-meeting-id` | When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:meetings:user:update'. | | `update-permission-profile-v2-permission-profile` | Update a permission profile. | | `upload-crm-objects-v2-crm-entities` | Uploads CRM entity data to Gong via LDJSON file. Use this to insert, update, or delete CRM entities (Accounts, Contacts, Deals, Leads, Stages... | | `validate-meeting-integration` | Validates Gong meeting integration status for one or more users by their email addresses. | [Open Gong in the console →](https://app.boxd.sh/integrations/detail/gong)