# Gong Gong is a platform for video meetings, call recording, and team collaboration. - **Category:** analytics - **Auth:** BASIC, OAUTH2 - **Composio Managed App Available?** No - **Tools:** 58 - **Triggers:** 0 - **Slug:** `GONG` - **Version:** 20260319_00 ## Tools ### Add call media **Slug:** `GONG_ADD_CALL_MEDIA_V2_CALLS_ID_MEDIA` Adds 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Call ID returned from "Add New Call" request | | `mediaFile` | object | Yes | Media file to upload (audio or video). Supports formats: WAV, MP3, MP4, MKV, FLAC. Maximum file size: 1.5GB. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add new call v2 calls **Slug:** `GONG_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. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:calls:create'. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `title` | string | No | The title of the call. This title is available in the Gong system for indexing and search. | | `context` | array | No | A list of references to external systems such as CRM, Telephony System, Case Management, etc. | | `parties` | array | Yes | A list of the call"s participants. A party must be provided for the primaryUser. | | `purpose` | string | No | The purpose of the call. This optional field is a free text of up to 255 characters. | | `duration` | integer | No | The actual call duration in seconds. | | `direction` | string ("Conference" | "Inbound" | "Outbound" | "Unknown") | Yes | Whether the call is inbound (someone called the company), outbound (a rep dialed someone outside the company), or a conference call. | | `customData` | string | No | Optional metadata associated with the call (represented as text). Gong stores this metadata and it can be used for troubleshooting. | | `meetingUrl` | string | No | The URL of the conference call by which users join the meeting | | `actualStart` | string | Yes | The actual date and time when the call started in the ISO-8601 format (e.g., "2018-02-18T02:30:00-07:00" or "2018-02-18T08:00:00Z", where Z stands for UTC); | | `disposition` | string | No | The disposition of the call. The disposition is free text of up to 255 characters. | | `primaryUser` | string | Yes | The Gong internal user ID of the team member who hosted the call. | | `workspaceId` | string | No | Optional workspace identifier. If specified, the call will be placed into this workspace, otherwise, the default algorithm for workspace placement will be applied. | | `languageCode` | string | No | The language code the call should be transcribed to. This field is optional as Gong automatically detects the language spoken in the call and transcribes it accordingly. Set this field only if you are sure of the language the call is in. Valid values are: af-ZA, am-ET, ar-AE, ar-BH, ar-DZ, ar-EG, ar-IL, ar-IQ, ar-JO, ar-KW, ar-LB, ar-MA, ar-MR, ar-OM, ar-PS, ar-QA, ar-SA, ar-TN, ar-YE, az-AZ, bg-BG, bn-BD, bn-IN, bs-BA, ca-ES, cs-CZ, da-DK, de-AT, de-CH, de-DE, el-GR, en-AB, en-AU, en-CA, en-GB, en-IE, en-IN, en-NZ, en-PH, en-SG, en-US, en-WL, en-ZA, es-AR, es-BO, es-CL, es-CO, es-CR, es-DO, es-EC, es-ES, es-GT, es-HN, es-MX, es-NI, es-PA, es-PE, es-PR, es-PY, es-SV, es-US, es-UY, et-EE, eu-ES, fa-IR, fi-FI, fil-PH, fr-BE, fr-CA, fr-CH, fr-FR, gl-ES, gu-IN, he-IL, hi-IN, hr-HR, hu-HU, hy-AM, id-ID, is-IS, it-CH, it-IT, ja-JP, jv-ID, ka-GE, kk-KZ, km-KH, kn-IN, ko-KR, lo-LA, lt-LT, lv-LV, mk-MK, ml-IN, mn-MN, mr-IN, ms-MY, my-MM, ne-NP, nl-BE, nl-NL, no-NO, pa-Guru-IN, pl-PL, pt-BR, pt-PT, ro-RO, ru-RU, si-LK, sk-SK, sl-SI, sq-AL, sr-RS, su-ID, sv-SE, sw-KE, sw-TZ, ta-IN, ta-LK, ta-MY, ta-SG, te-IN, th-TH, tr-TR, uk-UA, ur-IN, ur-PK, uz-UZ, vi-VN, yue-Hant-HK, zh-CN, zh-TW, zu-ZA | | `scheduledEnd` | string | No | The date and time the call was scheduled to end in the ISO-8601 format (e.g., "2018-02-18T02:30:00-07:00" or "2018-02-18T08:00:00Z", where Z stands for UTC); | | `clientUniqueId` | string | Yes | A call"s unique identifier in the PBX or the recording system. Gong uses this identifier to prevent repeated attempts to upload the same recording. | | `scheduledStart` | string | No | The date and time the call was scheduled to begin in the ISO-8601 format (e.g., "2018-02-18T02:30:00-07:00" or "2018-02-18T08:00:00Z", where Z stands for UTC); | | `callProviderCode` | string | No | The code identifies the provider conferencing or telephony system. For example: zoom, clearslide, gotomeeting, ringcentral, outreach, insidesales, etc. These values are predefined by Gong, please contact help@gong.io to find the proper value for your system. | | `downloadMediaUrl` | string | No | The URL from which Gong can download the media file. The URL must be unique, the audio or video file must be a maximum of 1.5GB. The content-type must either start with "audio" or "video," or should be "application/octet-stream" or "binary/octet-stream" followed by a subtype that specifies a supported file type (WAV, MP3, MP4, MKV and FLAC). If you provide this URL, you should not perform the "Add call media" step. | | `speakersTimeline__precise` | boolean | No | Indicates whether the provided speech segments match the media precisely or need further refinement based on the media. "Precisely" here means that segments do not deviate from the actual speech in the media by more than 100ms. | | `speakersTimeline__speechSegments` | array | No | The audio recording speech segments (who spoke when). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Aggregate activity by period via api **Slug:** `GONG_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. 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | When paging is needed, provide the value supplied by the previous API call to bring the following page of records. | | `filter__toDate` | string | No | The date (in the company"s time zone) until which to list a user"s activity. This value is exclusive. This value should not exceed the current day. The date should be specified in the following format: YYYY-MM-DD. | | `filter__userIds` | array | No | Set of Gong"s unique numeric identifiers for the users (up to 20 digits). | | `filter__fromDate` | string | No | The date (in the company"s time zone) from which to list a user"s activity. This value is inclusive. The date should be specified in the following format: YYYY-MM-DD. | | `aggregationPeriod` | string ("DAY" | "MONTH" | "QUARTER" | "WEEK" | "YEAR") | Yes | Calendar time period for aggregating data. Note: First day of the week is Monday. | | `filter__createdToDateTime` | string | No | Createdtodatetime | | `filter__createdFromDateTime` | string | No | Createdfromdatetime | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Aggregate user activity statistics **Slug:** `GONG_AGGREGATE_USER_ACTIVITY_STATISTICS` Lists 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | When paging is needed, provide the value supplied by the previous API call to bring the following page of records. | | `filter__toDate` | string | No | The date (in the company"s time zone) until which to list a user"s activity. This value is exclusive. This value should not exceed the current day. The date should be specified in the following format: YYYY-MM-DD. | | `filter__userIds` | array | No | Set of Gong"s unique numeric identifiers for the users (up to 20 digits). | | `filter__fromDate` | string | No | The date (in the company"s time zone) from which to list a user"s activity. This value is inclusive. The date should be specified in the following format: YYYY-MM-DD. | | `filter__createdToDateTime` | string | No | Optional filter by creation timestamp. The date and time in ISO-8601 format (e.g., '2024-01-17T16:20:05-03:00' or '2020-11-20T21:30:07.233692Z') until which to filter user activities by their creation time. This value is exclusive. | | `filter__createdFromDateTime` | string | No | Optional filter by creation timestamp. The date and time in ISO-8601 format (e.g., '2024-01-17T16:20:05-03:00' or '2020-11-20T21:30:07.233692Z') from which to filter user activities by their creation time. This value is inclusive. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Assign prospects to flow **Slug:** `GONG_ASSIGN_PROSPECTS_TO_FLOW` Use 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `flowId` | string | Yes | The Engage Flow ID to assign the contacts to. | | `crmProspectsIds` | array | Yes | The CRM IDs of the contact or lead that should be assigned to a flow | | `flowInstanceOwnerEmail` | string | Yes | The email of the Gong user who owns the flow to-dos. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Retrieve activity scorecards report **Slug:** `GONG_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 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | When paging is needed, provide the value supplied by the previous API call to bring the following page of records. | | `filter__callToDate` | string | No | The date (in the company's time zone) of the call until when to list calls. This value is exclusive. The date should be specified in the following format: YYYY-MM-DD; if not specified, it ends with the latest recorded call. | | `filter__callFromDate` | string | No | The date (in the company's time zone) of the call from when to list calls. This value is inclusive. The date should be specified in the following format: YYYY-MM-DD; if not specified, it starts with the earliest recorded call. | | `filter__reviewMethod` | string ("AUTOMATIC" | "BOTH" | "MANUAL") | No | Select whether to return scorecards that have been reviewed manually, automatically, or both. Default value: MANUAL | | `filter__reviewToDate` | string | No | The review date (in the company's time zone) until when to list calls. This value is exclusive. The date should be specified in the following format: YYYY-MM-DD; if not specified, it ends with the latest reviewed call. | | `filter__scorecardIds` | array | No | List of scorecards Ids. If not specified, it returns all answered scorecards in the corresponding filter. | | `filter__reviewFromDate` | string | No | The review date (in the company's time zone) from when to list calls. This value is inclusive. The date should be specified in the following format: YYYY-MM-DD; if not specified, it starts with the earliest reviewed call. | | `filter__reviewedUserIds` | array | No | List of user Ids of the team members being reviewed. If not specified, it returns all answered scorecards in the corresponding filter. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create a new gong meeting v2 meetings **Slug:** `GONG_CREATE_A_NEW_GONG_MEETING_V2_MEETINGS` When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:meetings:user:create'. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `title` | string | No | Title of the event. | | `endTime` | string | Yes | The meeting end time in ISO-8601 format (e.g., "2018-02-18T02:30:00-07:00" or "2018-02-18T08:00:00Z", where Z stands for UTC). | | `invitees` | array | Yes | A list of email addresses of invitees to the event (not including the organizer). | | `startTime` | string | Yes | The meeting start time in ISO-8601 format (e.g., "2018-02-18T02:30:00-07:00" or "2018-02-18T08:00:00Z", where Z stands for UTC). | | `externalId` | string | No | The ID as it is formed on the external system. | | `organizerEmail` | string | Yes | The email address of the user creating the meeting, the Gong consent page link will be used according to the settings of this user. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create permission profile v2 permission profile **Slug:** `GONG_CREATE_PERMISSION_PROFILE_V2_PERMISSION_PROFILE` Create a permission profile in a given workspace. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | No | Unique numeric identifier of the permission profile (up to 20 digits). | | `name` | string | No | Permission profile name. | | `deals` | boolean | No | User can view deals pages. | | `usage` | boolean | No | User can view usage pages. | | `market` | boolean | No | User can view market page. | | `account` | boolean | No | User can view account pages. | | `library` | boolean | No | User can view library pages. | | `activity` | boolean | No | User can view activity pages. | | `coaching` | boolean | No | User can view coaching pages. | | `forecast` | boolean | No | User can view forecast pages. | | `teamStats` | boolean | No | User can view team stats page. | | `trimCalls` | boolean | No | User can trim calls. | | `scoreCalls` | boolean | No | User can score calls. | | `deleteCalls` | boolean | No | User can delete calls. | | `description` | string | No | Permission profile description. | | `initiatives` | boolean | No | User can view initiatives page. | | `workspaceId` | string | Yes | Workspace identifier. You can retrieve the workspace using the "workspaces" (under "Settings") API. | | `deleteEmails` | boolean | No | User can delete emails. | | `privateCalls` | boolean | No | User can set their own calls as private. | | `crmDataImport` | boolean | No | User can perform import of crm data. | | `listenInCalls` | boolean | No | User can listen in calls. | | `overrideScore` | boolean | No | User can override someone else score. | | `callsAndSearch` | boolean | No | User can view and search calls. | | `forecastManage` | boolean | No | User can manage forecast boards and upload targets. | | `manageScorecards` | boolean | No | User can manage scorecards. | | `downloadCallMedia` | boolean | No | User can download call media. | | `dealsInlineEditing` | boolean | No | User can perform inline editing of deals. | | `crmDataInlineEditing` | boolean | No | User can perform inline editing of crm data. | | `viewRevenueAnalytics` | boolean | No | User can view dashboards page. | | `manageRevenueAnalytics` | boolean | No | User can manage revenue analytics. | | `shareCallsWithCustomers` | boolean | No | User can share calls with customers. | | `callsAccess__teamLeadIds` | array | No | List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API. | | `dealsAccess__teamLeadIds` | array | No | List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API. | | `usageAccess__teamLeadIds` | array | No | List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API. | | `viewEngageAnalyticsFlows` | boolean | No | User can view engage analytics flows page. | | `emailsAccess__teamLeadIds` | array | No | List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API. | | `coachingAccess__teamLeadIds` | array | No | List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API. | | `insightsAccess__teamLeadIds` | array | No | List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API. | | `viewEngageAnalyticsActivity` | boolean | No | User can view engage analytics activity page. | | `callsAccess__permissionLevel` | string ("all" | "all / managers-team / report-to-them / own / none" | "managers-team" | "none" | "own" | "report-to-them") | No | Permission access scope. | | `dealsAccess__permissionLevel` | string ("all" | "all / managers-team / report-to-them / own / none" | "managers-team" | "none" | "own" | "report-to-them") | No | Permission access scope. | | `engageManageCompanySequences` | boolean | No | User can manage company sequences. | | `engageManageCompanyTemplates` | boolean | No | User can manage company email templates. | | `usageAccess__permissionLevel` | string ("all" | "all / managers-team / report-to-them / own / none" | "managers-team" | "none" | "own" | "report-to-them") | No | Permission access scope. | | `emailsAccess__permissionLevel` | string ("all" | "all / managers-team / report-to-them / own / none" | "managers-team" | "none" | "own" | "report-to-them") | No | Permission access scope. | | `engageCreateAndManageRulesets` | boolean | No | User can create and manage rulesets. | | `manageGeneralBusinessSettings` | boolean | No | User can manage general business settings. | | `createEditAndDeleteDealsBoards` | boolean | No | User can create/edit/delete deals boards. | | `engageSnoozeFlowToDosForOthers` | boolean | No | User can snooze flow in to dos for others | | `manuallyScheduleAndUploadCalls` | boolean | No | User can manually schedule and upload calls. | | `viewEngageAnalyticsPerformance` | boolean | No | User can view engage analytics performance page. | | `coachingAccess__permissionLevel` | string ("all" | "all / managers-team / report-to-them / own / none" | "managers-team" | "none" | "own" | "report-to-them") | No | Permission access scope. | | `exportCallsAndCoachingDataToCSV` | boolean | No | User can export calls and coaching metrics data to CSV. | | `insightsAccess__permissionLevel` | string ("all" | "all / managers-team / report-to-them / own / none" | "managers-team" | "none" | "own" | "report-to-them") | No | Permission access scope. | | `libraryFolderAccess__manageStreams` | boolean | No | A user with this profile can manage streams, if set, "permissionLevel" must not be "none". | | `libraryFolderAccess__permissionLevel` | string ("all" | "none" | "none, all, specific-folders" | "specific-folders") | No | Library folder permission level - mandatory value. | | `libraryFolderAccess__libraryFolderIds` | array | No | List of library folder Ids, if set, "permissionLevel" must not be "none". | | `libraryFolderAccess__manageFolderCalls` | boolean | No | A user with this profile can add calls to folders, archive calls, if set, "permissionLevel" must not be "none". | | `libraryFolderAccess__managePublicFolder` | boolean | No | A user with this profile can manage public folder, if set, "permissionLevel" must not be "none". | | `libraryFolderAccess__shareFoldersAndStreams` | boolean | No | A user with this profile can share folders and streams from Your Library with other team members, if set, "permissionLevel" must not be "none". | | `forecastPermissions__forecastAccess__teamLeadIds` | array | No | List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API. | | `forecastPermissions__forecastAccess__permissionLevel` | string ("all" | "all / managers-team / report-to-them / own / none" | "managers-team" | "none" | "own" | "report-to-them") | No | Permission access scope. | | `forecastPermissions__forecastEditTargets__teamLeadIds` | array | No | List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API. | | `forecastPermissions__forecastEditSubmissions__teamLeadIds` | array | No | List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API. | | `forecastPermissions__forecastEditTargets__permissionLevel` | string ("all" | "all / managers-team / report-to-them / own / none" | "managers-team" | "none" | "own" | "report-to-them") | No | Permission access scope. | | `forecastPermissions__forecastEditSubmissions__permissionLevel` | string ("all" | "all / managers-team / report-to-them / own / none" | "managers-team" | "none" | "own" | "report-to-them") | No | Permission access scope. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Data privacy for phone number **Slug:** `GONG_DATA_PRIVACY_FOR_PHONE_NUMBER` Shows 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `phoneNumber` | string | Yes | The phone number. This number must start with a + (plus) sign followed by the country code, area code, and local phone number. All other non-digits are ignored. The following are examples of permitted phone numbers: +1 425 555 2671, +1-425-555-2671, +1 425 5552671, +14255552671, +1 425 555 26 71, +1(425) 555-2671, etc. Note: This parameter should be URL-encoded. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete a generic CRM integration **Slug:** `GONG_DELETE_A_GENERIC_CRM_INTEGRATION_V2_CRM_INTEGRATIONS` Deletes 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `integrationId` | integer | Yes | The unique ID of the generic CRM integration to delete. You can retrieve this ID using the 'get_crm_integration_details' action. Note: This must be the ID of a generic CRM integration created via the register_crm_integration action, NOT a native integration (Salesforce, HubSpot, etc.) set up through Gong's UI. The integration ID should be parsed as a Long/BigInt to avoid truncation. | | `clientRequestId` | string | Yes | A unique identifier that you generate for this specific delete request. This ID is used for troubleshooting and tracking the deletion process. Valid characters are letters (a-z, A-Z), numbers (0-9), dashes (-), and underscores (_). Example: 'delete-crm-20260129-001' or 'req_abc123'. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Meeting **Slug:** `GONG_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. Note: This endpoint is for meetings created through Gong's Meetings API, not for recorded calls accessible via the Calls API. Returns organizer email and request ID upon successful deletion. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `meeting_id` | string | Yes | Gong's unique numeric identifier for the meeting (up to 20 digits). This is the meeting ID returned when creating a meeting via the Gong Meetings API, not a call ID from the Calls API. | | `organizer_email` | string | Yes | The email address of the meeting organizer. Must match the organizer email used when the meeting was created. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete users from call access list **Slug:** `GONG_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. 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `callAccessList` | array | No | A list, in which each item specifies a call and a list of users to be removed from the call. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Erase data for email address **Slug:** `GONG_ERASE_DATA_FOR_EMAIL_ADDRESS` Erase 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `emailAddress` | string | Yes | The email address to permanently erase from the Gong system along with all associated data (calls, emails, leads, contacts). Example: 'user@example.com' | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Erase data for phone number **Slug:** `GONG_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. 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `phoneNumber` | string | Yes | The phone number. This number must start with a + (plus) sign followed by the country code, area code, and local phone number. All other non-digits are ignored. The following are examples of permitted phone numbers: +1 425 555 2671, +1-425-555-2671, +1 425 5552671, +14255552671, +1 425 555 26 71, +1(425) 555-2671, etc. Note: This parameter should be URL-encoded. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Fetch all permission profiles **Slug:** `GONG_FETCH_ALL_PERMISSION_PROFILES` Returns a list of all permission profiles. The listing is in the alphabetical order of the profile names. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `workspaceId` | string | Yes | Workspace identifier, the API will return only the profiles belonging to this workspace. You can retrieve the workspace using the "workspaces" (under "Settings") API. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Call By ID **Slug:** `GONG_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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `call_id` | string | Yes | Gong's unique numeric identifier for the call (up to 20 digits). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Call Transcript **Slug:** `GONG_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. Requires either a date range or specific call IDs to filter results. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | When paging is needed, provide the value supplied by the previous API call to bring the following page of records. | | `filter` | object | Yes | Filter criteria for retrieving call transcripts. At minimum, you should provide either date range (fromDateTime/toDateTime) or specific callIds. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Crm Integration Details **Slug:** `GONG_GET_CRM_INTEGRATION_DETAILS` Retrieves 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get crm objects v2 crm entities **Slug:** `GONG_GET_CRM_OBJECTS_V2_CRM_ENTITIES` Retrieves specific CRM objects by their IDs from Gong's CRM integration. Use this endpoint to fetch detailed information about CRM entities (accounts, contacts, deals, or leads) that have been uploaded to Gong through a registered CRM integration. This is particularly useful during development to verify that CRM objects are uploaded and processed correctly. Prerequisites: - A registered CRM integration (use the register CRM integration endpoint first) - CRM objects must be uploaded to Gong before they can be retrieved - You need the specific CRM IDs of the objects you want to fetch The response includes a crmObjectsMap containing the requested CRM objects with their fields and values as defined in your CRM system. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `objectType` | string ("ACCOUNT" | "CONTACT" | "DEAL" | "LEAD") | Yes | The type of CRM objects to retrieve. Valid options: ACCOUNT (companies), CONTACT (people), DEAL (opportunities), or LEAD (prospects). | | `integrationId` | integer | Yes | The integration ID generated when creating a CRM integration. This identifies which CRM integration to query. | | `objectsCrmIds` | array | Yes | List of CRM object IDs to retrieve. Specify the CRM IDs of the objects you want to fetch. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Flow Prospects **Slug:** `GONG_GET_FLOW_PROSPECTS` Tool 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `crmProspectsIds` | array | Yes | Array of CRM prospect IDs to query for assigned flows. The CRM IDs can be contact or lead IDs from your CRM system. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Interaction Statistics **Slug:** `GONG_GET_INTERACTION_STATISTICS` Tool 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Pagination cursor from a previous API call to retrieve the next page of records. | | `filter` | object | Yes | Filter parameters to specify the date range and optional user filters for interaction statistics. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get permission profile **Slug:** `GONG_GET_PERMISSION_PROFILE` Returns a permission profile. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `profileId` | string | Yes | Permission profile identifier. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get CRM Request Status **Slug:** `GONG_GET_REQUEST_STATUS_V2_CRM_REQUEST_STATUS` The 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `integrationId` | integer | Yes | Integration ID generated when creating the integration | | `clientRequestId` | string | Yes | The client request ID returned from an asynchronous CRM operation (e.g., from uploading CRM data) that you want to check the status for | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get User By ID **Slug:** `GONG_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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `user_id` | string | Yes | Gong's unique numeric identifier for the user (up to 20 digits). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get User Settings History **Slug:** `GONG_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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `user_id` | string | Yes | The unique Gong identifier for the user. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List all coaching metrics v2 coaching **Slug:** `GONG_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'. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `to` | string | Yes | Association time filter - only the associations made after that time will be listed. The time is in the ISO-8601 format (e.g., "2018-02-18T02:30:00-07:00" or "2018-02-18T08:00:00Z", where Z stands for UTC); if not specified all association events will be listed. | | `from` | string | Yes | Association time filter - only the associations made after that time will be listed. The time is in the ISO-8601 format (e.g., "2018-02-18T02:30:00-07:00" or "2018-02-18T08:00:00Z", where Z stands for UTC); if not specified all association events will be listed. | | `manager__id` | integer | Yes | Manager Id | | `workspace__id` | integer | Yes | Workspace Id | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List all company workspaces v2 workspaces **Slug:** `GONG_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 'api:workspaces:read'. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List all users v2 users **Slug:** `GONG_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'. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | When paging is needed, provide the value supplied by the previous API call to bring the following page of records. | | `includeAvatars` | boolean | No | Avatars are synthetic users representing Gong employees (CSMs and support providers) when they access your instance. References to avatars" IDs may be found in the outputs of other API endpoints. This parameter is optional, if not provided avatars will not be included in the results. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Call Outcomes **Slug:** `GONG_LIST_CALL_OUTCOMES` Tool to retrieve all available call outcomes defined in Gong. Use when you need to list all call outcome configurations including their categories, sentiments, and automation settings. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Flow Folders **Slug:** `GONG_LIST_FLOW_FOLDERS` Tool 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | When paging is needed, provide the value supplied by the previous API call to bring the following page of records. | | `parentId` | string | No | Optional folder identifier, if supplied the API will return only this folder and the child folders of this folder. | | `workspaceId` | string | No | Optional Workspace identifier, if supplied the API will return only the flows belonging to this workspace. | | `flowFolderOwnerEmail` | string | Yes | Email of the Gong user whose personal flows folders and flows folders shared with the user you want to return. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Folder Calls **Slug:** `GONG_LIST_FOLDER_CALLS` Given 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `folderId` | string | Yes | Gong's unique numeric identifier for the folder (up to 20 digits). This parameter is required to retrieve the list of calls in a specific library folder. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List gong engage flows v2 flows **Slug:** `GONG_LIST_GONG_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. * 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | When paging is needed, provide the value supplied by the previous API call to bring the following page of records. | | `workspaceId` | string | No | Optional Workspace identifier, if supplied the API will return only the flows belonging to this workspace. | | `flowOwnerEmail` | string | Yes | Email of the Gong user whose personal flows and flows shared with the user you want to return. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List schema fields v2 crm entity schema **Slug:** `GONG_LIST_SCHEMA_FIELDS_V2_CRM_ENTITY_SCHEMA` Retrieves 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `objectType` | string ("ACCOUNT" | "CONTACT" | "DEAL" | "LEAD") | Yes | CRM object type to retrieve schema fields for (case-sensitive). Must be one of: ACCOUNT, CONTACT, DEAL, or LEAD. | | `integrationId` | integer | Yes | The numeric integration ID returned when creating a Generic CRM integration via PUT /v2/crm/integrations. Parse as Long/BigInt to avoid truncation. Not compatible with native CRM integration IDs. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Scorecards **Slug:** `GONG_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. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Tasks **Slug:** `GONG_LIST_TASKS` Tool 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `filter` | object | Yes | Filter criteria for retrieving tasks. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List users by filter v2 users extensive **Slug:** `GONG_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'. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | When paging is needed, provide the value supplied by the previous API call to bring the following page of records. | | `filter__userIds` | array | No | A list of specific user IDs to retrieve. Provide Gong's unique numeric identifiers for the users you want to fetch (each ID can be up to 20 digits). If not provided, all users matching other filter criteria will be returned. | | `filter__includeAvatars` | boolean | No | Avatars are synthetic users representing Gong employees (CSMs and support providers) when they access your instance. References to avatars" IDs may be found in the outputs of other API endpoints. Defaults to False to exclude avatars from results. Set to True to include them. | | `filter__createdToDateTime` | string | No | An optional user creation time upper limit. If supplied, the API will return only the users created before this time. The field is in the ISO-8601 format (e.g., "2018-02-18T02:30:00-07:00" or "2018-02-18T08:00:00Z", where Z stands for UTC). | | `filter__createdFromDateTime` | string | No | An optional user creation time lower limit. If supplied, the API will return only the users created at or after this time. The field is in the ISO-8601 format (e.g., "2018-02-18T02:30:00-07:00" or "2018-02-18T08:00:00Z", where Z stands for UTC). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get user call access **Slug:** `GONG_MANAGE_USER_CALL_ACCESS` Retrieves 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `filter__callIds` | array | No | Array of Gong's unique numeric call IDs to query for user access information. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Post a digital interaction v2 digital interaction **Slug:** `GONG_POST_A_DIGITAL_INTERACTION_V2_DIGITAL_INTERACTION` When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:digital-interactions:write'. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `device` | string ("MOBILE" | "PC") | No | The device used during the event | | `eventId` | string | Yes | The provider"s unique identifier for the event used for deduplication | | `eventType` | string | Yes | The type of the event, explaining the content and action performed. Values may be partner-aligned, for example, "link clicked", "page viewed" | | `sessionId` | string | No | The identifier for the session, useful for tying related events together | | `timestamp` | string | Yes | The date and time of the event in ISO 8601 format | | `trackingId` | string | No | The ID used for tracking the person who did the event. Must be null if a person is sent instead. | | `customFields` | array | No | Include additional custom data about the event | | `person__name` | string | No | The name of the person | | `person__email` | string | No | The email address of the person. Used for business context association | | `person__personId` | string | No | A unique person identifier in the partner system. Mandatory for anonymous person, when the name, email, phoneNumber and personBusinessContext are empty | | `sourceSystemName` | string | No | When integrating via IPaaS, the name of the technology partner the customer set up a Gong integration with via an IPaaS. When integrating directly with Gong: the name of the company setting up the integration with Gong | | `content__contentId` | string | No | A unique identifier for the content in the partner"s system | | `content__contentUrl` | string | No | The URL for the content the person looked at | | `person__phoneNumber` | string | No | The phone number of the person. Used for business context association | | `content__contentLabel` | array | No | A list of tags defined for the content | | `content__contentTitle` | string | No | The title of the content | | `person__company__name` | string | No | The name of the company | | `person__location__city` | string | No | The city of the person | | `person__company__domain` | string | No | The domain of the person"s company. Used to associate the person with the company ("acme.com"). Mandatory for anonymous person, when the name, email, phoneNumber and personBusinessContext are empty | | `person__location__state` | string | No | The state of the person in ISO 3166-2. If not available in ISO 3166-2, then send as string | | `person__location__region` | string | No | The region of the person in ISO 3166-2. If not available in ISO 3166-2, then send as string | | `person__location__country` | string | No | The country of the person in ISO 3166. If not available in ISO 3166, then send as string | | `person__company__companyId` | string | No | The company ID in the partner"s source system | | `person__personCustomFields` | array | No | Include additional custom data about the person | | `content__contentCustomFields` | array | No | Include additional custom data about the content | | `content__contentAdditionalInfoUrl` | string | No | The URL for additional details provided by the website or external app, such as analysis of the content viewed | | `content__searchObjectDetails__url` | string | No | The URL of the entity in the partner system | | `content__searchObjectDetails__name` | string | No | The name of the entity the person searched for | | `content__stepContentDetails__value` | string | No | The current step the person is in, in the process | | `content__searchObjectDetails__domain` | string | No | The domain of the entity | | `content__numericContentDetails__value` | integer | No | The numeric value for the content | | `content__searchObjectDetails__objectId` | string | No | The ID of the entity in the partner system | | `content__numericContentDetails__rangeTo` | integer | No | The highest value that can be given to the content | | `person__personBusinessContext__objectId` | string | No | The ID of the object in the external system | | `content__searchObjectDetails__objectType` | string ("CATEGORY" | "PRODUCT" | "VENDOR") | No | The type of the entity the person searched for | | `person__company__companyBusinessContexts` | array | No | The company"s details in an external system such as the CRM. If the domain is empty, to enable association, send the crmAccountId or crmOpportunityId | | `content__numericContentDetails__rangeFrom` | integer | No | The lowest value that can be given to the content | | `person__personBusinessContext__objectType` | string ("CONTACT" | "LEAD") | No | The object type in the external system | | `person__personBusinessContext__systemName` | string | No | The name of the external system | | `content__numericContentDetails__numericType` | string ("NPS" | "OTHER" | "PERCENTAGE" | "RATING") | No | The type of numeric value | | `content__stepContentDetails__availableSteps` | array | No | A list of all available steps in the process | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Post day by day activity stats **Slug:** `GONG_POST_DAY_BY_DAY_ACTIVITY_STATS` Retrieve 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | When paging is needed, provide the value supplied by the previous API call to bring the following page of records. | | `filter__toDate` | string | No | The date (in the company"s time zone) until which to list a user"s activity. This value is exclusive. This value should not exceed the current day. The date should be specified in the following format: YYYY-MM-DD. | | `filter__userIds` | array | No | Set of Gong"s unique numeric identifiers for the users (up to 20 digits). | | `filter__fromDate` | string | No | The date (in the company"s time zone) from which to list a user"s activity. This value is inclusive. The date should be specified in the following format: YYYY-MM-DD. | | `filter__createdToDateTime` | string | No | The ending date and time (in ISO-8601 format) until which to filter user activity. For example: '2024-01-17T16:20:05-03:00' or '2020-11-20T21:30:07.233692Z'. | | `filter__createdFromDateTime` | string | No | The starting date and time (in ISO-8601 format) from which to filter user activity. For example: '2024-01-17T16:20:05-03:00' or '2020-11-20T21:30:07.233692Z'. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Register Crm Integration **Slug:** `GONG_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 Gong and your Customer Relationship Management (CRM) system. It's primarily used for changing the integration's name or reassigning the ownership to a different team member. This operation is crucial for maintaining accurate and up-to-date integration configurations, especially when there are changes in your organization's structure or integration strategies. Note that this endpoint only updates the integration metadata and does not affect the actual data synchronization between Gong and your CRM. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | The name of the integration | | `ownerEmail` | string | Yes | Email address of the person responsible for the integration | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Report Content Share Event **Slug:** `GONG_REPORT_CONTENT_SHARE_EVENT` Tool to push content share engagement events to Gong's activity timeline. Use when documenting that a Gong user shared content with external participants such as contracts or proposals. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sharer` | object | No | Information about the person who shared the content. | | `eventId` | string | No | Unique identifier for the event. | | `shareId` | string | No | Unique identifier for the share event. | | `contentId` | string | Yes | Unique identifier for the content being shared. | | `actionName` | string | No | The name of the action like "Contract Shared" or "Document Shared". | | `contentUrl` | string | Yes | Web address where the content is located. | | `recipients` | array | No | Array of recipient objects with name and email. Email is required for each recipient. | | `workspaceId` | string | No | Optional workspace identifier for event placement. | | `contentTitle` | string | Yes | Name or title of the shared content. | | `eventTimestamp` | string | Yes | When the sharing occurred in ISO-8601 format (e.g., '2025-12-15T10:30:00+00:00'). | | `reportingSystem` | string | Yes | Identifier of the system reporting the event. | | `sharingMessageBody` | string | No | The share message body text. | | `sharingMessageSubject` | string | No | The subject of the share email or message. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Report Content View Event **Slug:** `GONG_REPORT_CONTENT_VIEW_EVENT` Tool to log content view engagement events to Gong's activity timeline. Use when tracking external participants viewing shared content like documents or presentations. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `viewer` | object | No | Information about the viewer who accessed the content. | | `eventId` | string | No | Original event identifier from the reporting system for deduplication. | | `shareId` | string | No | Identifier for the content share action, if this view corresponds to a prior share event. | | `contentId` | string | Yes | Unique identifier of the viewed content in the reporting system. | | `userAgent` | string | No | Browser 'User-Agent' header value from the viewing session. | | `actionName` | string | No | The name of the action like "Document Viewed" or "Presentation Opened". | | `contentUrl` | string | Yes | The URL of the content that was accessed by the viewer. | | `mobileAppId` | string | No | Bundle identifier for mobile app interactions. | | `moreInfoUrl` | string | No | Link to additional information about the event. | | `viewInfoUrl` | string | No | Link presenting detailed event information. | | `workspaceId` | integer | No | Optional Gong workspace numeric identifier for event placement. | | `contentTitle` | string | Yes | Human-readable name or title of the content. | | `agentPlatform` | string | No | Platform where the interaction occurred (e.g., Windows, MacOS, iOS, Android). | | `eventTimestamp` | string | Yes | When the view occurred in ISO-8601 format (e.g., '2025-12-15T10:30:00Z'). Must be a past timestamp; future timestamps are rejected by the API. | | `eventProperties` | array | No | Additional properties related to the event. | | `reportingSystem` | string | Yes | Unique identifier of the system reporting the event. | | `viewActionTitle` | string | No | Name describing the specific viewing action taken. | | `contentProperties` | array | No | Additional properties/metadata associated with the content. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Report Custom Engagement Event **Slug:** `GONG_REPORT_CUSTOM_ENGAGEMENT_EVENT` Report custom engagement events to Gong's activity timeline. Use this action to track when external participants (prospects, customers) engage with content such as viewing documents, signing contracts, attending webinars, or downloading materials. The events appear in Gong's activity timeline and help track customer engagement. Required fields: reportingSystem (identifier for your system), eventTimestamp (ISO-8601 format), and actor information (at minimum actor__email and actor__name) to identify who performed the action. Common use cases: Document viewed, contract signed, webinar attended, presentation downloaded, proposal opened. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:engagement-data:write'. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `eventId` | string | No | The original id of the event as designated in the reporting system. | | `shareId` | string | No | Unique identifier for the content share action, if this engagement corresponds to a prior share event. | | `contentId` | string | No | The id of the content that was viewed in the reporting system. | | `userAgent` | string | No | "User-Agent" header value for browser based interaction | | `actionName` | string | No | The name of the action like "Document Viewed" or "Presentation Opened". | | `contentUrl` | string | No | The url of the content that was viewed in the reporting system. This is the url that is was accessed by the viewer. | | `crmContext` | array | No | A list of references to external systems such as CRM, Telephony System, Case Management, etc. | | `sharer__id` | string | No | The user id in Gong, if available. | | `trackingId` | string | No | Tracking identifier used for analytics or linking this event to other tracking systems. | | `actor__name` | string | No | The name of the person, if available. | | `mobileAppId` | string | No | The application identification string in case of interaction via mobile application (bundle identifier or package name). | | `moreInfoUrl` | string | No | URL to a page providing additional information or details about this engagement event. | | `workspaceId` | string | No | Optional workspace identifier. If specified, the event will be placed into this workspace, otherwise, the default algorithm for workspace placement will be applied. | | `actor__email` | string | No | The email address of the person, if available. | | `actor__title` | string | No | The title of the person, if available. | | `contentTitle` | string | No | Human readable title of the content. | | `eventInfoUrl` | string | No | The link to a page that presents additional information about this event. | | `sharer__name` | string | No | The name of the person, if available. | | `agentPlatform` | string ("Windows, Linux, MacOS, iOS, Android") | No | Platform on which the interaction was made | | `sharer__email` | string | No | The email address of the person, if available. | | `actor__context` | array | No | A list of links to external systems such as CRM, Telephony System, Case Management, etc. | | `eventTimestamp` | string | Yes | The date and time when the event happened in the ISO-8601 format (e.g., "2021-08-01T02:30:00+05:00" or "2021-08-01T08:00:00Z", where Z stands for UTC); | | `eventProperties` | array | No | A list of additional properties for the event | | `reportingSystem` | string | Yes | The unique identifier of the reporting system. It is the same value in all events originating from the same system. | | `contentProperties` | array | No | A list of additional properties for the content | | `sharingMessageBody` | string | No | Body text of the message used when sharing this content (e.g., email body). | | `sharingMessageSubject` | string | No | Subject line of the message used when sharing this content (e.g., email subject). | | `nonCompanyParticipants` | array | No | List of non-company participants (external contacts) involved in this engagement event, such as prospects or customers. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Retrieve call data by date range v2 calls **Slug:** `GONG_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 'api:calls:read:basic'. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | When paging is needed, provide the value supplied by the previous API call to bring the following page of records. | | `toDateTime` | string | Yes | Date and time (in ISO-8601 format: "2018-02-18T02:30:00-07:00" or "2018-02-18T08:00:00Z", where Z stands for UTC) until which to list recorded calls. Returns calls that started up to but excluding specified date and time. If not provided, list ends with most recent call. For web-conference calls recorded by Gong, the date denotes its scheduled time, otherwise, it denotes its actual start time. | | `workspaceId` | string | No | Optional Workspace identifier, if supplied the API will return only the calls belonging to this workspace. | | `fromDateTime` | string | Yes | Date and time (in ISO-8601 format: "2018-02-18T02:30:00-07:00" or "2018-02-18T08:00:00Z", where Z stands for UTC) from which to list recorded calls. Returns calls that started on or after the specified date and time. If not provided, list starts with earliest call. For web-conference calls recorded by Gong, the date denotes its scheduled time, otherwise, it denotes its actual start time. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Retrieve data privacy info for email address **Slug:** `GONG_RETRIEVE_DATA_PRIVACY_INFO_FOR_EMAIL_ADDRESS` Retrieves 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `emailAddress` | string | Yes | The third-party email address to search for (e.g., customer, prospect, or external contact). Note: This cannot be an internal Gong user's email address. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Retrieve filtered call details **Slug:** `GONG_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. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:calls:read:extensive'. Moreover, clients requesting media download URLs by the contentSelector.exposedFields.media field should also have the scope 'api:calls:read:media-url'. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque pagination token from records.cursor field of a previous response. Do NOT provide on first request. Do NOT use keywords like 'next' or 'previous'. Only use exact cursor string returned by this endpoint in a prior call. Cannot be used together with filter parameters (fromDateTime, toDateTime, workspaceId, callIds, primaryUserIds) as cursors encode the original query context. | | `filter__callIds` | array | No | List of calls Ids to be filtered. If not supplied, returns all calls between fromDateTime and toDateTime. | | `filter__toDateTime` | string | No | Date and time (in ISO-8601 format: "2018-02-18T02:30:00-07:00" or "2018-02-18T08:00:00Z", where Z stands for UTC) until which to list recorded calls. Returns calls that started up to but excluding specified date and time. If not provided, list ends with most recent call. The date applies to call start time. | | `filter__workspaceId` | string | No | Optional Workspace identifier, if supplied the API will return only the calls belonging to this workspace. | | `filter__fromDateTime` | string | No | Date and time (in ISO-8601 format: "2018-02-18T02:30:00-07:00" or "2018-02-18T08:00:00Z", where Z stands for UTC) from which to list recorded calls. Returns calls that started on or after the specified date and time. If not provided, list starts with earliest call. The date applies to call start time. | | `filter__primaryUserIds` | array | No | An optional list of user identifiers, if supplied the API will return only the calls hosted by the specified users. The identifiers in this field match the primaryUserId field of the calls. | | `contentSelector__context` | string ("Basic" | "Extended" | "None") | No | If "Basic", add links to external systems (context objects) such as CRM, Telephony System, Case Management. If "Extended" include also data (context fields) for these links. Default value "None" | | `contentSelector__contextTiming` | array | No | Timing for the context data. The field is optional and can contain either "Now" or "TimeOfCall" or both. The default value is ["Now"]. Can be provided only when the context field is set to "Extended" | | `contentSelector__exposedFields__media` | boolean | No | If true and exist, add audio url and video url of the call. The urls will be available for 8 hours. | | `contentSelector__exposedFields__parties` | boolean | No | If true, add information about the parties of the call | | `contentSelector__exposedFields__content__brief` | boolean | No | When true, returns the spotlight call brief. | | `contentSelector__exposedFields__content__topics` | boolean | No | If true, add duration of call topics | | `contentSelector__exposedFields__content__outline` | boolean | No | When true, returns the call outline. | | `contentSelector__exposedFields__content__trackers` | boolean | No | If true, returns smart tracker and keyword tracker information for the call. | | `contentSelector__exposedFields__content__keyPoints` | boolean | No | When true, returns the key points of the call. | | `contentSelector__exposedFields__content__structure` | boolean | No | If true, add call agenda, if available | | `contentSelector__exposedFields__interaction__video` | boolean | No | If true, add video statistics | | `contentSelector__exposedFields__content__highlights` | boolean | No | When true, returns the call highlights. | | `contentSelector__exposedFields__content__callOutcome` | boolean | No | When true, returns the outcome of the call. | | `contentSelector__exposedFields__interaction__speakers` | boolean | No | If true, add the time each participant spoke. | | `contentSelector__exposedFields__interaction__questions` | boolean | No | If true, add question counts | | `contentSelector__exposedFields__personInteractionStats` | boolean | No | If true, add statistics for the host of the call. | | `contentSelector__exposedFields__content__pointsOfInterest` | boolean | No | If true, add call points of interest | | `contentSelector__exposedFields__content__trackerOccurrences` | boolean | No | If true, the API will return the timing and speaker ID of each occurrence of a tracker (in addition to other tracker data). This functionality must be used in combination with the "trackers" field. The occurrence data is available only for the calls recorded since Jan 1, 2023, contact Gong support if a backfill of this data is required. | | `contentSelector__exposedFields__collaboration__publicComments` | boolean | No | If true, add public comments made for this call | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Retrieve library folders v2 library folders **Slug:** `GONG_RETRIEVE_LIBRARY_FOLDERS_V2_LIBRARY_FOLDERS` Use 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `workspaceId` | string | Yes | Workspace identifier. We will retrieve folders which are related to this specific workspace. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Retrieve logs data by type and time range v2 logs **Slug:** `GONG_RETRIEVE_LOGS_DATA_BY_TYPE_AND_TIME_RANGE_V2_LOGS` List 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | When paging is needed, provide the value supplied by the previous API call to bring the following page of records. | | `logType` | string ("AccessLog" | "ExternallySharedCallAccess" | "ExternallySharedCallPlay" | "UserActivityLog" | "UserCallPlay") | Yes | Type of logs requested. | | `toDateTime` | string | No | The time until which to retrieve log records, in the ISO-8601 format (e.g., "2018-02-18T02:30:00-07:00" or "2018-02-18T08:00:00Z", where Z stands for UTC); if not specified, the logs end with the latest recorded log. | | `fromDateTime` | string | Yes | The time from which to retrieve log records, in the ISO-8601 format (e.g., "2018-02-18T02:30:00-07:00" or "2018-02-18T08:00:00Z", where Z stands for UTC). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Retrieve manual crm call associations **Slug:** `GONG_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. 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | When paging is needed, provide the value supplied by the previous API call to bring the following page of records. | | `fromDateTime` | string | Yes | Association time filter - only the associations made after that time will be listed. The time is in the ISO-8601 format (e.g., "2018-02-18T02:30:00-07:00" or "2018-02-18T08:00:00Z", where Z stands for UTC). Required parameter. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Retrieve tracker details v2 settings trackers **Slug:** `GONG_RETRIEVE_TRACKER_DETAILS_V2_SETTINGS_TRACKERS` Retrieves 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `workspaceId` | string | No | The ID of the workspace the keyword trackers are in. When empty, all trackers in all workspaces are returned. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Retrieve transcripts of calls v2 calls transcript (Deprecated) **Slug:** `GONG_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. 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | When paging is needed, provide the value supplied by the previous API call to bring the following page of records. | | `filter__callIds` | array | No | List of calls Ids to be filtered. If not supplied, returns all calls between fromDateTime and toDateTime. | | `filter__toDateTime` | string | No | Date and time in ISO-8601 format until which to list recorded calls. REQUIRED FORMAT: 'YYYY-MM-DDTHH:MM:SS' with timezone as 'Z' (UTC) or offset like '+HH:MM' or '-HH:MM'. Examples: '2018-02-18T02:30:00-07:00', '2018-02-18T08:00:00Z', '2024-01-15T14:30:00+05:30'. Returns calls that started up to but excluding specified date and time. If not provided, list ends with most recent call. The date applies to call start time. | | `filter__workspaceId` | string | No | Optional Workspace identifier, if supplied the API will return only the calls belonging to this workspace. | | `filter__fromDateTime` | string | No | Date and time in ISO-8601 format from which to list recorded calls. REQUIRED FORMAT: 'YYYY-MM-DDTHH:MM:SS' with timezone as 'Z' (UTC) or offset like '+HH:MM' or '-HH:MM'. Examples: '2018-02-18T02:30:00-07:00', '2018-02-18T08:00:00Z', '2024-01-15T14:30:00+05:30'. Returns calls that started on or after the specified date and time. If not provided, list starts with earliest call. The date applies to call start time. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Retrieve users from permission profile **Slug:** `GONG_RETRIEVE_USERS_FROM_PERMISSION_PROFILE` Returns a list of all users whose access is controlled by the given permission profile. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:users:read'. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `profileId` | string | Yes | Permission profile identifier. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Set User Call Access **Slug:** `GONG_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 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `callAccessList` | array | Yes | A list of call access entries. Each entry specifies a call ID and the user IDs to be granted access to that call. Multiple calls can be processed in a single request. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Unassign Flows By CRM ID **Slug:** `GONG_UNASSIGN_FLOWS_BY_CRM_ID` Tool 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `flowId` | string | No | The identifier of the flow to unassign the prospect from. If not provided, the prospect will be unassigned from all flows. | | `crmProspectId` | string | Yes | The CRM ID of the prospect to unassign from flows. This is the contact or lead ID from your CRM system. | | `unassignedByUserEmail` | string | No | The email address of the Gong user requesting to remove prospects from the flow instance. This is not the email of the prospect being removed from the flow. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update a gong meeting v2 meetings meetingid **Slug:** `GONG_UPDATE_A_GONG_MEETING_V2_MEETINGS_MEETING_ID` When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:meetings:user:update'. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `title` | string | No | Title of the event. | | `endTime` | string | Yes | The meeting end time in ISO-8601 format (e.g., "2018-02-18T02:30:00-07:00" or "2018-02-18T08:00:00Z", where Z stands for UTC). | | `invitees` | array | Yes | A list of email addresses of invitees to the event (not including the organizer). | | `meetingId` | integer | Yes | Gong"s unique identifier for the meeting (up to 20 digits). | | `startTime` | string | Yes | The meeting start time in ISO-8601 format (e.g., "2018-02-18T02:30:00-07:00" or "2018-02-18T08:00:00Z", where Z stands for UTC). | | `externalId` | string | No | The ID as it is formed on the external system. | | `organizerEmail` | string | Yes | The email address of the user who created the meeting. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update permission profile v2 permission profile **Slug:** `GONG_UPDATE_PERMISSION_PROFILE_V2_PERMISSION_PROFILE` Update a permission profile. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | No | Unique numeric identifier of the permission profile (up to 20 digits). | | `name` | string | No | Permission profile name. | | `deals` | boolean | No | User can view deals pages. | | `usage` | boolean | No | User can view usage pages. | | `market` | boolean | No | User can view market page. | | `account` | boolean | No | User can view account pages. | | `library` | boolean | No | User can view library pages. | | `activity` | boolean | No | User can view activity pages. | | `coaching` | boolean | No | User can view coaching pages. | | `forecast` | boolean | No | User can view forecast pages. | | `profileId` | string | Yes | Permission profile identifier. | | `teamStats` | boolean | No | User can view team stats page. | | `trimCalls` | boolean | No | User can trim calls. | | `scoreCalls` | boolean | No | User can score calls. | | `deleteCalls` | boolean | No | User can delete calls. | | `description` | string | No | Permission profile description. | | `initiatives` | boolean | No | User can view initiatives page. | | `deleteEmails` | boolean | No | User can delete emails. | | `privateCalls` | boolean | No | User can set their own calls as private. | | `crmDataImport` | boolean | No | User can perform import of crm data. | | `listenInCalls` | boolean | No | User can listen in calls. | | `overrideScore` | boolean | No | User can override someone else score. | | `callsAndSearch` | boolean | No | User can view and search calls. | | `forecastManage` | boolean | No | User can manage forecast boards and upload targets. | | `manageScorecards` | boolean | No | User can manage scorecards. | | `downloadCallMedia` | boolean | No | User can download call media. | | `dealsInlineEditing` | boolean | No | User can perform inline editing of deals. | | `crmDataInlineEditing` | boolean | No | User can perform inline editing of crm data. | | `viewRevenueAnalytics` | boolean | No | User can view dashboards page. | | `manageRevenueAnalytics` | boolean | No | User can manage revenue analytics. | | `shareCallsWithCustomers` | boolean | No | User can share calls with customers. | | `callsAccess__teamLeadIds` | array | No | List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API. | | `dealsAccess__teamLeadIds` | array | No | List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API. | | `usageAccess__teamLeadIds` | array | No | List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API. | | `viewEngageAnalyticsFlows` | boolean | No | User can view engage analytics flows page. | | `emailsAccess__teamLeadIds` | array | No | List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API. | | `coachingAccess__teamLeadIds` | array | No | List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API. | | `insightsAccess__teamLeadIds` | array | No | List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API. | | `viewEngageAnalyticsActivity` | boolean | No | User can view engage analytics activity page. | | `callsAccess__permissionLevel` | string ("all" | "all / managers-team / report-to-them / own / none" | "managers-team" | "none" | "own" | "report-to-them") | No | Permission access scope. | | `dealsAccess__permissionLevel` | string ("all" | "all / managers-team / report-to-them / own / none" | "managers-team" | "none" | "own" | "report-to-them") | No | Permission access scope. | | `engageManageCompanySequences` | boolean | No | User can manage company sequences. | | `engageManageCompanyTemplates` | boolean | No | User can manage company email templates. | | `usageAccess__permissionLevel` | string ("all" | "all / managers-team / report-to-them / own / none" | "managers-team" | "none" | "own" | "report-to-them") | No | Permission access scope. | | `emailsAccess__permissionLevel` | string ("all" | "all / managers-team / report-to-them / own / none" | "managers-team" | "none" | "own" | "report-to-them") | No | Permission access scope. | | `engageCreateAndManageRulesets` | boolean | No | User can create and manage rulesets. | | `manageGeneralBusinessSettings` | boolean | No | User can manage general business settings. | | `createEditAndDeleteDealsBoards` | boolean | No | User can create/edit/delete deals boards. | | `engageSnoozeFlowToDosForOthers` | boolean | No | User can snooze flow in to dos for others | | `manuallyScheduleAndUploadCalls` | boolean | No | User can manually schedule and upload calls. | | `viewEngageAnalyticsPerformance` | boolean | No | User can view engage analytics performance page. | | `coachingAccess__permissionLevel` | string ("all" | "all / managers-team / report-to-them / own / none" | "managers-team" | "none" | "own" | "report-to-them") | No | Permission access scope. | | `exportCallsAndCoachingDataToCSV` | boolean | No | User can export calls and coaching metrics data to CSV. | | `insightsAccess__permissionLevel` | string ("all" | "all / managers-team / report-to-them / own / none" | "managers-team" | "none" | "own" | "report-to-them") | No | Permission access scope. | | `libraryFolderAccess__manageStreams` | boolean | No | A user with this profile can manage streams, if set, "permissionLevel" must not be "none". | | `libraryFolderAccess__permissionLevel` | string ("all" | "none" | "none, all, specific-folders" | "specific-folders") | No | Library folder permission level - mandatory value. | | `libraryFolderAccess__libraryFolderIds` | array | No | List of library folder Ids, if set, "permissionLevel" must not be "none". | | `libraryFolderAccess__manageFolderCalls` | boolean | No | A user with this profile can add calls to folders, archive calls, if set, "permissionLevel" must not be "none". | | `libraryFolderAccess__managePublicFolder` | boolean | No | A user with this profile can manage public folder, if set, "permissionLevel" must not be "none". | | `libraryFolderAccess__shareFoldersAndStreams` | boolean | No | A user with this profile can share folders and streams from Your Library with other team members, if set, "permissionLevel" must not be "none". | | `forecastPermissions__forecastAccess__teamLeadIds` | array | No | List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API. | | `forecastPermissions__forecastAccess__permissionLevel` | string ("all" | "all / managers-team / report-to-them / own / none" | "managers-team" | "none" | "own" | "report-to-them") | No | Permission access scope. | | `forecastPermissions__forecastEditTargets__teamLeadIds` | array | No | List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API. | | `forecastPermissions__forecastEditSubmissions__teamLeadIds` | array | No | List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API. | | `forecastPermissions__forecastEditTargets__permissionLevel` | string ("all" | "all / managers-team / report-to-them / own / none" | "managers-team" | "none" | "own" | "report-to-them") | No | Permission access scope. | | `forecastPermissions__forecastEditSubmissions__permissionLevel` | string ("all" | "all / managers-team / report-to-them / own / none" | "managers-team" | "none" | "own" | "report-to-them") | No | Permission access scope. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Upload crm objects v2 crm entities **Slug:** `GONG_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, 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `dataFile` | object | Yes | LDJSON (Line-Delimited JSON) file containing CRM entity data. Each line in the file should be a valid JSON object with 'objectId', 'objectType', and 'fields' array containing name-value pairs for the entity attributes. | | `objectType` | string | Yes | The type of CRM entity being uploaded. Valid values: ACCOUNT, CONTACT, DEAL, LEAD, STAGE, BUSINESS_USER | | `integrationId` | integer | Yes | The ID of your CRM integration. Obtained from registering a CRM integration via /v2/crm/integrations endpoint. Note: Parse as Long or BigInt to avoid truncation. | | `clientRequestId` | string | No | A unique identifier for this request, used for tracking and troubleshooting purposes. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Validate Meeting Integration **Slug:** `GONG_VALIDATE_MEETING_INTEGRATION` Validates 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. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `user_emails` | array | Yes | List of user email addresses to check meeting integration status for. Provide the email addresses of Gong users you want to validate. Accepts 1-100 email addresses per request. The API will check each user's meeting integration configuration and return status information if there are any issues. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not |