- Category: analytics
- Auth: BASIC, OAUTH2
- Composio-managed OAuth available? Yes
- Tools: 58
- Triggers: 0
- Slug:
GONG - Version: 20261101_00
Frequently Asked Questions
Which IP addresses should I allowlist for Gong OAuth?
Which IP addresses should I allowlist for Gong OAuth?
52.72.72.59/3254.243.138.89/3254.224.131.195/3234.233.50.61/32
Tools
Add call media
Add call media
GONG_ADD_CALL_MEDIA_V2_CALLS_ID_MEDIAAdds a call media, recorded by a telephony system (PBX) or other media recording facility. Gong accepts call recordings in various audio and video file formats, including WAV, MP3, MP4, MKV and FLAC. If uploading a dual-channel (stereo) file separated by speaker, make sure to specify which channel corresponds to the company team member (rep) in the parties/mediaChannelId parameter of the Add New Call operation. When accessed through a Bearer token authorization method, this endpoint requires the scope ‘api:calls:create’.Input Parameters
Output
Add new call v2 calls
Add new call v2 calls
GONG_ADD_NEW_CALL_V2_CALLSCreate a new call in Gong. Provide a download media URL or use the returned call ID in a follow-up media upload; bearer-token access requires the ‘api:calls:create’ scope.Input Parameters
Output
Aggregate activity by period via api
Aggregate activity by period via api
GONG_AGGREGATE_ACTIVITY_BY_PERIOD_VIA_APILists the aggregated activity of multiple users within the Gong system for each time period within the defined date range. This endpoint returns multiple records, one for each user. For each user there are items for every time period in the date range, including statistics about the user’s activity. Records are returned only for users with activity in the range. When accessed through a Bearer token authorization method, this endpoint requires the scope ‘api:stats:user-actions’.Input Parameters
Output
Aggregate user activity statistics
Aggregate user activity statistics
GONG_AGGREGATE_USER_ACTIVITY_STATISTICSLists the activity of multiple users within the Gong system during a defined period. Given the period, this endpoint returns multiple records, one for each user, with an applicable activity during the period. Each record includes statistics about the user’s activity. When accessed through a Bearer token authorization method, this endpoint requires the scope ‘api:stats:user-actions’.Input Parameters
Output
Assign prospects to flow
Assign prospects to flow
GONG_ASSIGN_PROSPECTS_TO_FLOWUse this endpoint to assign a number of prospects to a flow. Prospects can be contacts or leads in your CRM. Generate a list of comma separated CRM Ids of the prospects you want to add to a flow. The flowInstanceOwnerEmail parameter is the email address of the Gong user who set up the flow instance and owns the flow to-dos. You can assign up to 200 prospects to a flow in a single request. When accessed through a Bearer token authorization method, this endpoint requires the scope ‘api:flows:write’.Input Parameters
Output
Retrieve activity scorecards report
Retrieve activity scorecards report
GONG_CREATE_ACTIVITY_SCORECARDS_REPORTRetrieve 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 users. When accessed through a Bearer token authorization method, this endpoint requires the scope ‘api:stats:scorecards’.Input Parameters
Output
Create a new gong meeting v2 meetings
Create a new gong meeting v2 meetings
GONG_CREATE_A_NEW_GONG_MEETING_V2_MEETINGSCreate a Gong meeting. Bearer token access requires the ‘api:meetings:user:create’ scope.Input Parameters
Output
Create permission profile v2 permission profile
Create permission profile v2 permission profile
GONG_CREATE_PERMISSION_PROFILE_V2_PERMISSION_PROFILECreate a permission profile in a given workspace.Input Parameters
Output
Data privacy for phone number
Data privacy for phone number
GONG_DATA_PRIVACY_FOR_PHONE_NUMBERShows the elements in the Gong system that reference the given phone number. Given a phone number, this endpoint returns details of any leads or contacts with this phone number and their associated calls and email messages. When accessed through a Bearer token authorization method, this endpoint requires the scope ‘api:data-privacy:read’.Input Parameters
Output
Delete a generic CRM integration
Delete a generic CRM integration
GONG_DELETE_A_GENERIC_CRM_INTEGRATION_V2_CRM_INTEGRATIONSDeletes an existing generic CRM integration from the Gong platform. This endpoint asynchronously removes a CRM integration and all its associated CRM objects (Accounts, Contacts, Deals, Leads, and Users). Use this when you want to disconnect a previously established integration between Gong and a CRM system. IMPORTANT: This endpoint only works with generic CRM integrations created via the ‘register_crm_integration’ action. It does NOT delete native integrations (e.g., Salesforce, HubSpot) that were set up directly through Gong’s UI. The deletion is permanent and cannot be undone, so use with caution. This operation will affect data synchronization and may impact existing analytics or reports that rely on the integrated CRM data. Before deletion, you can retrieve existing integration details using the ‘get_crm_integration_details’ action to verify the integration ID.Input Parameters
Output
Delete Meeting
Delete Meeting
GONG_DELETE_MEETINGDeletes a Gong meeting created via the Meetings API (Beta), using its meeting ID and organizer’s email address.Input Parameters
Output
Delete users from call access list
Delete users from call access list
GONG_DELETE_USERS_FROM_CALL_ACCESS_LISTRemove individual user access from calls. The request can only remove access previously given by the /v2/calls/users-access API. If a given user does not have access to the call, they will be unaffected. If a given user does have access to the call, but not through the public API (for example if the call was shared with the user), the user’s access will remain unchanged. When accessed through a Bearer token authorization method, this endpoint requires the scope ‘api:call-user-access:write’.Input Parameters
Output
Erase data for email address
Erase data for email address
GONG_ERASE_DATA_FOR_EMAIL_ADDRESSErase all data associated with an email address from Gong (GDPR compliance). This endpoint permanently deletes from the Gong system: - All calls where the email address appears (as lead, contact, attendee, or speaker) - All email messages sent to or from the address - All leads or contacts with this email address IMPORTANT NOTES: - The deletion is NOT immediate and may take several hours to complete - Has a data integrity protection mechanism to prevent deletion of abnormal number of objects - Delete the data from your CRM and email system BEFORE this operation to prevent re-import - If deletion fails, contact support at help@gong.io - Requires Bearer token scope: ‘api:data-privacy:delete’ CAUTION: This is a destructive operation that cannot be undone.Input Parameters
Output
Erase data for phone number
Erase data for phone number
GONG_ERASE_DATA_FOR_PHONE_NUMBERGiven a phone number, this endpoint deletes from the Gong system any leads or contacts with a matching phone number or mobile phone number. Email messages sent to or from these leads/contacts are deleted. Calls where the leads/contacts appear are deleted. The deletion is not immediate, and may take several hours to complete. This endpoint contains a data integrity protection mechanism to prevent the deletion of an abnormal number of objects. If the deletion fails please contact support at help@gong.io Delete the data from your CRM and email system before performing this operation so that private data is not re-imported into Gong. When accessed through a Bearer token authorization method, this endpoint requires the scope ‘api:data-privacy:delete’.Input Parameters
Output
Fetch all permission profiles
Fetch all permission profiles
GONG_FETCH_ALL_PERMISSION_PROFILESList permission profiles for a specified workspace, in alphabetical order by profile name.Input Parameters
Output
Get Call By ID
Get Call By ID
Get Call Transcript
Get Call Transcript
GONG_GET_CALL_TRANSCRIPTTool to retrieve call transcripts from Gong. Use when you need to access the text content of calls with speaker information, timestamps, and topic categorization. Requires either a date range or specific call IDs to filter results.Input Parameters
Output
Get Crm Integration Details
Get Crm Integration Details
GONG_GET_CRM_INTEGRATION_DETAILSRetrieves details of generic CRM integrations registered with Gong. This endpoint returns generic CRM integrations that were set up using the PUT /v2/crm/integrations endpoint. It does NOT return native integrations (e.g., SALESFORCE, HubSpot) that are configured through Gong’s UI. Note: Gong allows only one active CRM integration at a time (either generic or native). If a native integration is active, you cannot register a generic integration until the native one is disconnected. Returns an empty list if no generic CRM integrations exist. Required OAuth scope: ‘api:crm:integrations:read’Output
Get crm objects v2 crm entities
Get crm objects v2 crm entities
GONG_GET_CRM_OBJECTS_V2_CRM_ENTITIESRequests uploaded CRM objects by integration, object type and CRM IDs to verify during development that they were uploaded and processed correctly. Gong limits results to the first 100 objects and represents missing objects as null. Bearer-token access requires the api:crm:get-objects scope.Input Parameters
Output
Get Flow Prospects
Get Flow Prospects
GONG_GET_FLOW_PROSPECTSTool to retrieve Gong Engage flows assigned to specified prospects. Use when you need to get flow instance IDs and details for specific CRM prospect IDs. Requires ‘api:flows:read’ scope.Input Parameters
Output
Get Interaction Statistics
Get Interaction Statistics
GONG_GET_INTERACTION_STATISTICSTool to retrieve interaction trend statistics for users based on calls with Whisper enabled. Use when analyzing user interaction patterns, measuring engagement metrics, or tracking communication behaviors over a specified date range. Returns metrics like interactivity, question rate, longest monologue, and patience levels.Input Parameters
Output
Get permission profile
Get permission profile
Get CRM Request Status
Get CRM Request Status
GONG_GET_REQUEST_STATUS_V2_CRM_REQUEST_STATUSThe GetCRMRequestStatus endpoint retrieves the current status of CRM integration requests in the Gong platform. It allows users to check the progress and outcome of operations related to CRM data uploads, synchronization, or other CRM-related processes. This endpoint is particularly useful for monitoring the health and progress of CRM integrations, troubleshooting issues, and ensuring data consistency between Gong and connected CRM systems. It should be used when you need to verify if a CRM integration request has been completed, is still in progress, or has encountered any errors. The endpoint does not modify any data and is intended for status checking only. Note that the specific details returned may vary depending on the type and complexity of the CRM integration request being queried.Input Parameters
Output
Get User By ID
Get User By ID
Get User Settings History
Get User Settings History
List all coaching metrics v2 coaching
List all coaching metrics v2 coaching
GONG_LIST_ALL_COACHING_METRICS_V2_COACHINGList all of the coaching metrics of a manager. When accessed through a Bearer token authorization method, this endpoint requires the scope ‘api:coaching:read’.Input Parameters
Output
List all company workspaces v2 workspaces
List all company workspaces v2 workspaces
List all users v2 users
List all users v2 users
GONG_LIST_ALL_USERS_V2_USERSList all of the company’s users. When accessed through a Bearer token authorization method, this endpoint requires the scope ‘api:users:read’.Input Parameters
Output
List Call Outcomes
List Call Outcomes
List Flow Folders
List Flow Folders
GONG_LIST_FLOW_FOLDERSTool to list all Gong Engage flow folders with visibility types. Use when you need to retrieve company flow folders, personal folders, and folders shared with a specific user.Input Parameters
Output
List Folder Calls
List Folder Calls
GONG_LIST_FOLDER_CALLSGiven a folder id, this endpoint retrieves a list of calls in it. When accessed through a Bearer token authorization method, this endpoint requires the scope ‘api:library:read’.Input Parameters
Output
List gong engage flows v2 flows
List gong engage flows v2 flows
GONG_LIST_GONG_ENGAGE_FLOWS_V2_FLOWSEngage flows have the following visibility types: * Company: visible to everyone in the company, can only be edited by users with edit permissions. * Personal: reps can set up their own flows which are only available to them. * Shared: reps can share a flow with other reps. Those reps can then add leads to the flow. This endpoint returns all company flows, together with personal flows and flows shared with the user specified in the flowOwnerEmail parameter. When accessed through a Bearer token authorization method, use the ‘api:flows:read’ scope.Input Parameters
Output
List schema fields v2 crm entity schema
List schema fields v2 crm entity schema
GONG_LIST_SCHEMA_FIELDS_V2_CRM_ENTITY_SCHEMARetrieves schema fields for a specific CRM object type within a Generic CRM integration. Returns field metadata including names, data types (STRING, NUMBER, PICKLIST, etc.), labels, reference relationships, and picklist values for ACCOUNT, CONTACT, DEAL, or LEAD objects. IMPORTANT: Only works with Generic CRM integrations created via /v2/crm/integrations API. Does NOT work with native integrations (Salesforce, HubSpot, Dynamics 365). Required: integrationId (from Generic CRM integration creation), objectType (ACCOUNT/CONTACT/DEAL/LEAD).Input Parameters
Output
List Scorecards
List Scorecards
List Tasks
List Tasks
GONG_LIST_TASKSTool to retrieve Engage tasks assigned to a specific user with filtering options. Use when you need to list tasks by status, action type, and other criteria. Requires ‘api:tasks:read’ scope.Input Parameters
Output
List users by filter v2 users extensive
List users by filter v2 users extensive
GONG_LIST_USERS_BY_FILTER_V2_USERS_EXTENSIVEList multiple Users. When accessed through a Bearer token authorization method, this endpoint requires the scope ‘api:users:read’.Input Parameters
Output
Get user call access
Get user call access
GONG_MANAGE_USER_CALL_ACCESSRetrieves a list of users who have been granted individual access to specific calls through the API. This endpoint returns only users with explicit API-granted access and doesn’t include users who have access through other means (such as being sharing recipients or having access through permission profiles). When accessed through a Bearer token authorization method, this endpoint requires the scope ‘api:call-user-access:read’.Input Parameters
Output
Post a digital interaction v2 digital interaction
Post a digital interaction v2 digital interaction
GONG_POST_A_DIGITAL_INTERACTION_V2_DIGITAL_INTERACTIONPost a digital interaction event to Gong. Bearer-token access requires the ‘api:digital-interactions:write’ scope.Input Parameters
Output
Post day by day activity stats
Post day by day activity stats
GONG_POST_DAY_BY_DAY_ACTIVITY_STATSRetrieve the daily activity of multiple users within the Gong system for a range of dates. This endpoint returns records including statistics about each user’s activity, on the daily level. Records are returned only for users with activity in the range. When accessed through a Bearer token authorization method, this endpoint requires the scope ‘api:stats:user-actions:detailed’.Input Parameters
Output
Register Crm Integration
Register Crm Integration
Report Content View Event
Report Content View Event
GONG_REPORT_CONTENT_VIEW_EVENTReport content view engagement events to Gong’s activity timeline when external participants view shared content. The legacy Engagement API is a limited release.Input Parameters
Output
Report Custom Engagement Event
Report Custom Engagement Event
GONG_REPORT_CUSTOM_ENGAGEMENT_EVENTReport custom engagement events to Gong’s activity timeline for external participants’ interactions with content. The legacy Engagement API is a limited release; bearer-token access requires the ‘api:engagement-data:write’ scope.Input Parameters
Output
Retrieve call data by date range v2 calls
Retrieve call data by date range v2 calls
GONG_RETRIEVE_CALL_DATA_BY_DATE_RANGE_V2_CALLSList calls that took place during a specified date range. When accessed through a Bearer token authorization method, this endpoint requires the scope ‘api:calls:read:basic’.Input Parameters
Output
Retrieve data privacy info for email address
Retrieve data privacy info for email address
GONG_RETRIEVE_DATA_PRIVACY_INFO_FOR_EMAIL_ADDRESSRetrieves data privacy information for a third-party email address. Shows all elements in the Gong system that reference the given email address, including calls, email messages, meetings, customer data, and engagement events. This endpoint is designed for third-party privacy requests (e.g., customers, prospects, or external contacts) and will reject internal Gong user email addresses. When accessed through a Bearer token authorization, this endpoint requires the scope ‘api:data-privacy:read’.Input Parameters
Output
Retrieve filtered call details
Retrieve filtered call details
GONG_RETRIEVE_FILTERED_CALL_DETAILSLists detailed call data filtered by date range, call IDs, workspace or host users; cursor requests cannot include filters. Bearer access requires api:calls:read:extensive, and requesting media URLs also requires api:calls:read:media-url.Input Parameters
Output
Retrieve library folders v2 library folders
Retrieve library folders v2 library folders
GONG_RETRIEVE_LIBRARY_FOLDERS_V2_LIBRARY_FOLDERSUse this endpoint to retrieve a list of public library folders. We do not allow retrieval of either private or archived folders. When accessed through a Bearer token authorization method, this endpoint requires the scope ‘api:library:read’.Input Parameters
Output
Retrieve logs data by type and time range v2 logs
Retrieve logs data by type and time range v2 logs
GONG_RETRIEVE_LOGS_DATA_BY_TYPE_AND_TIME_RANGE_V2_LOGSList log entries that took place during a specified time range. When accessed through a Bearer token authorization method, this endpoint requires the scope ‘api:logs:read’.Input Parameters
Output
Retrieve manual crm call associations
Retrieve manual crm call associations
GONG_RETRIEVE_MANUAL_CRM_CALL_ASSOCIATIONSReturns a list of all calls that were manually associated or re-associated with CRM account and deal/opportunity since a given time. Actions will be listed in the ascending order of their timing. Notice if a call was associated and later re-associated the API will return both events. When accessed through a Bearer token authorization method, this endpoint requires the scope ‘api:crm-calls:manual-association:read’.Input Parameters
Output
Retrieve tracker details v2 settings trackers
Retrieve tracker details v2 settings trackers
GONG_RETRIEVE_TRACKER_DETAILS_V2_SETTINGS_TRACKERSRetrieves details of all keyword trackers in the system or in a given workspace. When accessed through a Bearer token authorization method, this endpoint requires the ‘api:settings:trackers:read’ scope.Input Parameters
Output
Retrieve transcripts of calls v2 calls transcript (Deprecated)
Retrieve transcripts of calls v2 calls transcript (Deprecated)
GONG_RETRIEVE_TRANSCRIPTS_OF_CALLS_V2_CALLS_TRANSCRIPTDEPRECATED: Use GONG_GET_CALL_TRANSCRIPT instead. Returns transcripts for calls that took place during the specified date period. If call IDs are specified, only transcripts for calls with those IDs that took place during the time period are returned. When accessed through a Bearer token authorization method, this endpoint requires the scope ‘api:calls:read:transcript’.Input Parameters
Output
Retrieve users from permission profile
Retrieve users from permission profile
Set User Call Access
Set User Call Access
GONG_SET_USER_CALL_ACCESSGive individual users access to calls. If a user already has access (perhaps the call was shared with them, or they have access through their permission profiles) the request will have no effect. When accessed through a Bearer token authorization method, this endpoint requires the scope ‘api:call-user-access:write’.Input Parameters
Output
Unassign Flows By CRM ID
Unassign Flows By CRM ID
GONG_UNASSIGN_FLOWS_BY_CRM_IDTool to unassign flows from prospects by their CRM Prospect ID. Use when you need to remove a prospect from specific flows or all flows in Gong Engage.Input Parameters
Output
Update a gong meeting v2 meetings meetingid
Update a gong meeting v2 meetings meetingid
GONG_UPDATE_A_GONG_MEETING_V2_MEETINGS_MEETING_IDUpdate a Gong meeting by ID. Bearer token access requires the ‘api:meetings:user:update’ scope.Input Parameters
Output
Update permission profile v2 permission profile
Update permission profile v2 permission profile
GONG_UPDATE_PERMISSION_PROFILE_V2_PERMISSION_PROFILEUpdate a permission profile.Input Parameters
Output
Upload crm objects v2 crm entities
Upload crm objects v2 crm entities
GONG_UPLOAD_CRM_OBJECTS_V2_CRM_ENTITIESUploads CRM entity data to Gong via LDJSON file. Use this to insert, update, or delete CRM entities (Accounts, Contacts, Deals, Leads, Stages, Business Users) in Gong’s platform. The file should be in LDJSON format (Line-Delimited JSON) where each line is a separate JSON object representing one entity. Each entity object must include ‘objectId’ (unique CRM ID), ‘objectType’ (matching the objectType parameter), and ‘fields’ (array of name-value pairs for entity attributes). Maximum file size is 200MB. After upload, use the returned requestId with /v2/crm/request-status to check processing status. Requires ‘api:crm:upload’ scope and a registered CRM integration (via /v2/crm/integrations).Input Parameters
Output
Validate Meeting Integration
Validate Meeting Integration
GONG_VALIDATE_MEETING_INTEGRATIONValidates Gong meeting integration status for one or more users by their email addresses. This endpoint checks if users have their meeting integration properly configured in Gong. Returns status information including whether users exist, if their integration is valid, and any error messages with help/fix URLs if issues are found. Use this when you need to: - Verify meeting integration is working for specific users - Diagnose meeting recording or import issues - Check if users are properly set up to use Gong meeting features - Troubleshoot why meetings aren’t being captured for certain users Note: The API returns an empty array when all specified users have valid integration or when users don’t have meeting integration issues to report.