Skip to main content
Gong logo
  • Category: analytics
  • Auth: BASIC, OAUTH2
  • Composio-managed OAuth available? Yes
  • Tools: 58
  • Triggers: 0
  • Slug: GONG
  • Version: 20261101_00

Frequently Asked Questions

Gong now requires every OAuth integration to have trusted IP addresses configured. Gong’s release notes list this change as announced in September 2026, with release in October 2026. If Gong gave your integration an October 15, 2026 deadline, add these IPs before that date.If you use your own Gong OAuth integration with Composio, add all four Composio IPs to both the Access Token and Refresh Token trusted IP lists:
  • 52.72.72.59/32
  • 54.243.138.89/32
  • 54.224.131.195/32
  • 34.233.50.61/32
Composio’s traffic to Gong can come from any of these addresses. If you add only some of them, or add them to only one list, API calls or token refreshes can fail intermittently.For setup steps, see Gong’s guide to adding trusted IPs to your integration.

Tools

Slug: GONG_ADD_CALL_MEDIA_V2_CALLS_ID_MEDIAAdds a call media, recorded by a telephony system (PBX) or other media recording facility. Gong accepts call recordings in various audio and video file formats, including WAV, MP3, MP4, MKV and FLAC. If uploading a dual-channel (stereo) file separated by speaker, make sure to specify which channel corresponds to the company team member (rep) in the parties/mediaChannelId parameter of the Add New Call operation. When accessed through a Bearer token authorization method, this endpoint requires the scope ‘api:calls:create’.

Input Parameters

string
required
Call ID returned from “Add New Call” request
object
required
Media file to upload (audio or video). Supports formats: WAV, MP3, MP4, MKV, FLAC. Maximum file size: 1.5GB.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_ADD_NEW_CALL_V2_CALLSCreate a new call in Gong. Provide a download media URL or use the returned call ID in a follow-up media upload; bearer-token access requires the ‘api:calls:create’ scope.

Input Parameters

string
The title of the call. This title is available in the Gong system for indexing and search.
array
A list of references to external systems such as CRM, Telephony System, Case Management, etc.
array
required
A list of the call”s participants. A party must be provided for the primaryUser.
string
The purpose of the call. This optional field is a free text of up to 255 characters.
integer
The actual call duration in seconds.
string ("Conference" | "Inbound" | "Outbound" | "Unknown")
required
Whether the call is inbound (someone called the company), outbound (a rep dialed someone outside the company), or a conference call.
string
Optional metadata associated with the call (represented as text). Gong stores this metadata and it can be used for troubleshooting.
string
The URL of the conference call by which users join the meeting
string
required
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);
string
The disposition of the call. The disposition is free text of up to 255 characters.
string
required
The Gong internal user ID of the team member who hosted the call.
string
Optional workspace identifier. If specified, the call will be placed into this workspace, otherwise, the default algorithm for workspace placement will be applied.
string
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
string
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);
string
required
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.
string
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);
string
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.
string
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.
boolean
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.
array
The audio recording speech segments (who spoke when).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_AGGREGATE_ACTIVITY_BY_PERIOD_VIA_APILists the aggregated activity of multiple users within the Gong system for each time period within the defined date range. This endpoint returns multiple records, one for each user. For each user there are items for every time period in the date range, including statistics about the user’s activity. Records are returned only for users with activity in the range. When accessed through a Bearer token authorization method, this endpoint requires the scope ‘api:stats:user-actions’.

Input Parameters

string
When paging is needed, provide the value supplied by the previous API call to bring the following page of records.
string
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.
array
Set of Gong”s unique numeric identifiers for the users (up to 20 digits).
string
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.
string ("DAY" | "MONTH" | "QUARTER" | "WEEK" | "YEAR")
required
Calendar time period for aggregating data. Note: First day of the week is Monday.
string
Createdtodatetime
string
Createdfromdatetime

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_AGGREGATE_USER_ACTIVITY_STATISTICSLists the activity of multiple users within the Gong system during a defined period. Given the period, this endpoint returns multiple records, one for each user, with an applicable activity during the period. Each record includes statistics about the user’s activity. When accessed through a Bearer token authorization method, this endpoint requires the scope ‘api:stats:user-actions’.

Input Parameters

string
When paging is needed, provide the value supplied by the previous API call to bring the following page of records.
string
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.
array
Set of Gong”s unique numeric identifiers for the users (up to 20 digits).
string
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.
string
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.
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_ASSIGN_PROSPECTS_TO_FLOWUse this endpoint to assign a number of prospects to a flow. Prospects can be contacts or leads in your CRM. Generate a list of comma separated CRM Ids of the prospects you want to add to a flow. The flowInstanceOwnerEmail parameter is the email address of the Gong user who set up the flow instance and owns the flow to-dos. You can assign up to 200 prospects to a flow in a single request. When accessed through a Bearer token authorization method, this endpoint requires the scope ‘api:flows:write’.

Input Parameters

string
required
The Engage Flow ID to assign the contacts to.
array
required
The CRM IDs of the contact or lead that should be assigned to a flow
string
required
The email of the Gong user who owns the flow to-dos.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_CREATE_ACTIVITY_SCORECARDS_REPORTRetrieve all the answers for the scorecards that were reviewed during a specified date range, for calls that took place during a specified date range, for specific scorecards or for specific reviewed users. When accessed through a Bearer token authorization method, this endpoint requires the scope ‘api:stats:scorecards’.

Input Parameters

string
When paging is needed, provide the value supplied by the previous API call to bring the following page of records.
string
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.
string
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.
string ("AUTOMATIC" | "BOTH" | "MANUAL")
Select whether to return scorecards that have been reviewed manually, automatically, or both. Default value: MANUAL
string
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.
array
List of scorecards Ids. If not specified, it returns all answered scorecards in the corresponding filter.
string
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.
array
List of user Ids of the team members being reviewed. If not specified, it returns all answered scorecards in the corresponding filter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_CREATE_A_NEW_GONG_MEETING_V2_MEETINGSCreate a Gong meeting. Bearer token access requires the ‘api:meetings:user:create’ scope.

Input Parameters

string
Title of the event.
string
required
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).
array
required
A list of email addresses of invitees to the event (not including the organizer).
string
required
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).
string
The ID as it is formed on the external system.
string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_CREATE_PERMISSION_PROFILE_V2_PERMISSION_PROFILECreate a permission profile in a given workspace.

Input Parameters

string
Unique numeric identifier of the permission profile (up to 20 digits).
string
Permission profile name.
boolean
User can view deals pages.
boolean
User can view usage pages.
boolean
User can view market page.
boolean
User can view account pages.
boolean
User can view library pages.
boolean
User can view activity pages.
boolean
User can view coaching pages.
boolean
User can view forecast pages.
boolean
User can view team stats page.
boolean
User can trim calls.
boolean
User can score calls.
boolean
User can delete calls.
string
Permission profile description.
boolean
User can view initiatives page.
string
required
Workspace identifier. You can retrieve the workspace using the “workspaces” (under “Settings”) API.
boolean
User can delete emails.
boolean
User can set their own calls as private.
boolean
User can perform import of crm data.
boolean
User can listen in calls.
boolean
User can override someone else score.
User can view and search calls.
boolean
User can manage forecast boards and upload targets.
boolean
User can manage scorecards.
boolean
User can download call media.
boolean
User can perform inline editing of deals.
boolean
User can perform inline editing of crm data.
boolean
User can view dashboards page.
boolean
User can manage revenue analytics.
boolean
User can share calls with customers.
array
List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API.
array
List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API.
array
List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API.
boolean
User can view engage analytics flows page.
array
List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API.
array
List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API.
array
List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API.
boolean
User can view engage analytics activity page.
string ("all" | "all / managers-team / report-to-them / own / none" | "managers-team" | "none" | "own" | "report-to-them")
Permission access scope.
string ("all" | "all / managers-team / report-to-them / own / none" | "managers-team" | "none" | "own" | "report-to-them")
Permission access scope.
boolean
User can manage company sequences.
boolean
User can manage company email templates.
string ("all" | "all / managers-team / report-to-them / own / none" | "managers-team" | "none" | "own" | "report-to-them")
Permission access scope.
string ("all" | "all / managers-team / report-to-them / own / none" | "managers-team" | "none" | "own" | "report-to-them")
Permission access scope.
boolean
User can create and manage rulesets.
boolean
User can manage general business settings.
boolean
User can create/edit/delete deals boards.
boolean
User can snooze flow in to dos for others
boolean
User can manually schedule and upload calls.
boolean
User can view engage analytics performance page.
string ("all" | "all / managers-team / report-to-them / own / none" | "managers-team" | "none" | "own" | "report-to-them")
Permission access scope.
boolean
User can export calls and coaching metrics data to CSV.
string ("all" | "all / managers-team / report-to-them / own / none" | "managers-team" | "none" | "own" | "report-to-them")
Permission access scope.
boolean
A user with this profile can manage streams, if set, “permissionLevel” must not be “none”.
string ("all" | "none" | "none, all, specific-folders" | "specific-folders")
Library folder permission level - mandatory value.
array
List of library folder Ids, if set, “permissionLevel” must not be “none”.
boolean
A user with this profile can add calls to folders, archive calls, if set, “permissionLevel” must not be “none”.
boolean
A user with this profile can manage public folder, if set, “permissionLevel” must not be “none”.
boolean
A user with this profile can share folders and streams from Your Library with other team members, if set, “permissionLevel” must not be “none”.
array
List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API.
string ("all" | "all / managers-team / report-to-them / own / none" | "managers-team" | "none" | "own" | "report-to-them")
Permission access scope.
array
List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API.
array
List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API.
string ("all" | "all / managers-team / report-to-them / own / none" | "managers-team" | "none" | "own" | "report-to-them")
Permission access scope.
string ("all" | "all / managers-team / report-to-them / own / none" | "managers-team" | "none" | "own" | "report-to-them")
Permission access scope.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_DATA_PRIVACY_FOR_PHONE_NUMBERShows the elements in the Gong system that reference the given phone number. Given a phone number, this endpoint returns details of any leads or contacts with this phone number and their associated calls and email messages. When accessed through a Bearer token authorization method, this endpoint requires the scope ‘api:data-privacy:read’.

Input Parameters

string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_DELETE_A_GENERIC_CRM_INTEGRATION_V2_CRM_INTEGRATIONSDeletes an existing generic CRM integration from the Gong platform. This endpoint asynchronously removes a CRM integration and all its associated CRM objects (Accounts, Contacts, Deals, Leads, and Users). Use this when you want to disconnect a previously established integration between Gong and a CRM system. IMPORTANT: This endpoint only works with generic CRM integrations created via the ‘register_crm_integration’ action. It does NOT delete native integrations (e.g., Salesforce, HubSpot) that were set up directly through Gong’s UI. The deletion is permanent and cannot be undone, so use with caution. This operation will affect data synchronization and may impact existing analytics or reports that rely on the integrated CRM data. Before deletion, you can retrieve existing integration details using the ‘get_crm_integration_details’ action to verify the integration ID.

Input Parameters

integer
required
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.
string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_DELETE_MEETINGDeletes a Gong meeting created via the Meetings API (Beta), using its meeting ID and organizer’s email address.

Input Parameters

string
required
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.
string
required
The email address of the meeting organizer. Must match the organizer email used when the meeting was created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_DELETE_USERS_FROM_CALL_ACCESS_LISTRemove individual user access from calls. The request can only remove access previously given by the /v2/calls/users-access API. If a given user does not have access to the call, they will be unaffected. If a given user does have access to the call, but not through the public API (for example if the call was shared with the user), the user’s access will remain unchanged. When accessed through a Bearer token authorization method, this endpoint requires the scope ‘api:call-user-access:write’.

Input Parameters

array
A list, in which each item specifies a call and a list of users to be removed from the call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_ERASE_DATA_FOR_EMAIL_ADDRESSErase all data associated with an email address from Gong (GDPR compliance). This endpoint permanently deletes from the Gong system: - All calls where the email address appears (as lead, contact, attendee, or speaker) - All email messages sent to or from the address - All leads or contacts with this email address IMPORTANT NOTES: - The deletion is NOT immediate and may take several hours to complete - Has a data integrity protection mechanism to prevent deletion of abnormal number of objects - Delete the data from your CRM and email system BEFORE this operation to prevent re-import - If deletion fails, contact support at help@gong.io - Requires Bearer token scope: ‘api:data-privacy:delete’ CAUTION: This is a destructive operation that cannot be undone.

Input Parameters

string
required
The email address to permanently erase from the Gong system along with all associated data (calls, emails, leads, contacts). Example: ‘user@example.com’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_ERASE_DATA_FOR_PHONE_NUMBERGiven a phone number, this endpoint deletes from the Gong system any leads or contacts with a matching phone number or mobile phone number. Email messages sent to or from these leads/contacts are deleted. Calls where the leads/contacts appear are deleted. The deletion is not immediate, and may take several hours to complete. This endpoint contains a data integrity protection mechanism to prevent the deletion of an abnormal number of objects. If the deletion fails please contact support at help@gong.io Delete the data from your CRM and email system before performing this operation so that private data is not re-imported into Gong. When accessed through a Bearer token authorization method, this endpoint requires the scope ‘api:data-privacy:delete’.

Input Parameters

string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_FETCH_ALL_PERMISSION_PROFILESList permission profiles for a specified workspace, in alphabetical order by profile name.

Input Parameters

string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_GET_CALL_BY_IDTool 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

string
required
Gong’s unique numeric identifier for the call (up to 20 digits).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_GET_CALL_TRANSCRIPTTool to retrieve call transcripts from Gong. Use when you need to access the text content of calls with speaker information, timestamps, and topic categorization. Requires either a date range or specific call IDs to filter results.

Input Parameters

string
When paging is needed, provide the value supplied by the previous API call to bring the following page of records.
object
required
Filter criteria for retrieving call transcripts. At minimum, you should provide either date range (fromDateTime/toDateTime) or specific callIds.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_GET_CRM_INTEGRATION_DETAILSRetrieves details of generic CRM integrations registered with Gong. This endpoint returns generic CRM integrations that were set up using the PUT /v2/crm/integrations endpoint. It does NOT return native integrations (e.g., SALESFORCE, HubSpot) that are configured through Gong’s UI. Note: Gong allows only one active CRM integration at a time (either generic or native). If a native integration is active, you cannot register a generic integration until the native one is disconnected. Returns an empty list if no generic CRM integrations exist. Required OAuth scope: ‘api:crm:integrations:read’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_GET_CRM_OBJECTS_V2_CRM_ENTITIESRequests uploaded CRM objects by integration, object type and CRM IDs to verify during development that they were uploaded and processed correctly. Gong limits results to the first 100 objects and represents missing objects as null. Bearer-token access requires the api:crm:get-objects scope.

Input Parameters

string ("ACCOUNT" | "CONTACT" | "DEAL" | "LEAD")
required
The type of CRM objects to retrieve. Valid options: ACCOUNT (companies), CONTACT (people), DEAL (opportunities), or LEAD (prospects).
integer
required
The integration ID generated when creating a CRM integration. This identifies which CRM integration to query.
array
required
List of CRM object IDs to retrieve. Specify the CRM IDs of the objects you want to fetch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_GET_FLOW_PROSPECTSTool to retrieve Gong Engage flows assigned to specified prospects. Use when you need to get flow instance IDs and details for specific CRM prospect IDs. Requires ‘api:flows:read’ scope.

Input Parameters

array
required
Array of CRM prospect IDs to query for assigned flows. The CRM IDs can be contact or lead IDs from your CRM system.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_GET_INTERACTION_STATISTICSTool to retrieve interaction trend statistics for users based on calls with Whisper enabled. Use when analyzing user interaction patterns, measuring engagement metrics, or tracking communication behaviors over a specified date range. Returns metrics like interactivity, question rate, longest monologue, and patience levels.

Input Parameters

string
Pagination cursor from a previous API call to retrieve the next page of records.
object
required
Filter parameters to specify the date range and optional user filters for interaction statistics.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_GET_PERMISSION_PROFILEReturns a permission profile.

Input Parameters

string
required
Permission profile identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_GET_REQUEST_STATUS_V2_CRM_REQUEST_STATUSThe GetCRMRequestStatus endpoint retrieves the current status of CRM integration requests in the Gong platform. It allows users to check the progress and outcome of operations related to CRM data uploads, synchronization, or other CRM-related processes. This endpoint is particularly useful for monitoring the health and progress of CRM integrations, troubleshooting issues, and ensuring data consistency between Gong and connected CRM systems. It should be used when you need to verify if a CRM integration request has been completed, is still in progress, or has encountered any errors. The endpoint does not modify any data and is intended for status checking only. Note that the specific details returned may vary depending on the type and complexity of the CRM integration request being queried.

Input Parameters

integer
required
Integration ID generated when creating the integration
string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_GET_USER_BY_IDTool 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

string
required
Gong’s unique numeric identifier for the user (up to 20 digits).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_GET_USER_SETTINGS_HISTORYTool 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

string
required
The unique Gong identifier for the user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_LIST_ALL_COACHING_METRICS_V2_COACHINGList all of the coaching metrics of a manager. When accessed through a Bearer token authorization method, this endpoint requires the scope ‘api:coaching:read’.

Input Parameters

string
required
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.
string
required
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.
string
required
Manager Id
string
required
Workspace Id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_LIST_ALL_COMPANY_WORKSPACES_V2_WORKSPACESReturns 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_LIST_ALL_USERS_V2_USERSList all of the company’s users. When accessed through a Bearer token authorization method, this endpoint requires the scope ‘api:users:read’.

Input Parameters

string
When paging is needed, provide the value supplied by the previous API call to bring the following page of records.
boolean
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_LIST_CALL_OUTCOMESTool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_LIST_FLOW_FOLDERSTool to list all Gong Engage flow folders with visibility types. Use when you need to retrieve company flow folders, personal folders, and folders shared with a specific user.

Input Parameters

string
When paging is needed, provide the value supplied by the previous API call to bring the following page of records.
string
Optional folder identifier, if supplied the API will return only this folder and the child folders of this folder.
string
Optional Workspace identifier, if supplied the API will return only the flows belonging to this workspace.
string
required
Email of the Gong user whose personal flows folders and flows folders shared with the user you want to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_LIST_FOLDER_CALLSGiven a folder id, this endpoint retrieves a list of calls in it. When accessed through a Bearer token authorization method, this endpoint requires the scope ‘api:library:read’.

Input Parameters

string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_LIST_GONG_ENGAGE_FLOWS_V2_FLOWSEngage flows have the following visibility types: * Company: visible to everyone in the company, can only be edited by users with edit permissions. * Personal: reps can set up their own flows which are only available to them. * Shared: reps can share a flow with other reps. Those reps can then add leads to the flow. This endpoint returns all company flows, together with personal flows and flows shared with the user specified in the flowOwnerEmail parameter. When accessed through a Bearer token authorization method, use the ‘api:flows:read’ scope.

Input Parameters

string
When paging is needed, provide the value supplied by the previous API call to bring the following page of records.
string
Optional Workspace identifier, if supplied the API will return only the flows belonging to this workspace.
string
required
Email of the Gong user whose personal flows and flows shared with the user you want to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_LIST_SCHEMA_FIELDS_V2_CRM_ENTITY_SCHEMARetrieves schema fields for a specific CRM object type within a Generic CRM integration. Returns field metadata including names, data types (STRING, NUMBER, PICKLIST, etc.), labels, reference relationships, and picklist values for ACCOUNT, CONTACT, DEAL, or LEAD objects. IMPORTANT: Only works with Generic CRM integrations created via /v2/crm/integrations API. Does NOT work with native integrations (Salesforce, HubSpot, Dynamics 365). Required: integrationId (from Generic CRM integration creation), objectType (ACCOUNT/CONTACT/DEAL/LEAD).

Input Parameters

string ("ACCOUNT" | "CONTACT" | "DEAL" | "LEAD")
required
CRM object type to retrieve schema fields for (case-sensitive). Must be one of: ACCOUNT, CONTACT, DEAL, or LEAD.
integer
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_LIST_SCORECARDSTool to retrieve all scorecards within the Gong system. Use when you need to list all scorecard configurations and their associated assessment questions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_LIST_TASKSTool to retrieve Engage tasks assigned to a specific user with filtering options. Use when you need to list tasks by status, action type, and other criteria. Requires ‘api:tasks:read’ scope.

Input Parameters

string
When paging is needed, provide the value supplied by the previous API call to bring the following page of records.
object
required
Filter criteria for retrieving tasks.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_LIST_USERS_BY_FILTER_V2_USERS_EXTENSIVEList multiple Users. When accessed through a Bearer token authorization method, this endpoint requires the scope ‘api:users:read’.

Input Parameters

string
When paging is needed, provide the value supplied by the previous API call to bring the following page of records.
array
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.
boolean
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.
string
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).
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_MANAGE_USER_CALL_ACCESSRetrieves a list of users who have been granted individual access to specific calls through the API. This endpoint returns only users with explicit API-granted access and doesn’t include users who have access through other means (such as being sharing recipients or having access through permission profiles). When accessed through a Bearer token authorization method, this endpoint requires the scope ‘api:call-user-access:read’.

Input Parameters

array
Array of Gong’s unique numeric call IDs to query for user access information.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_POST_A_DIGITAL_INTERACTION_V2_DIGITAL_INTERACTIONPost a digital interaction event to Gong. Bearer-token access requires the ‘api:digital-interactions:write’ scope.

Input Parameters

string ("MOBILE" | "PC")
The device used during the event
string
required
The provider”s unique identifier for the event used for deduplication
string
required
The type of the event, explaining the content and action performed. Values may be partner-aligned, for example, “link clicked”, “page viewed”
string
The identifier for the session, useful for tying related events together
string
required
The date and time of the event in ISO 8601 format
string
The ID used for tracking the person who did the event. Must be null if a person is sent instead.
array
Include additional custom data about the event
string
The name of the person
string
The email address of the person. Used for business context association
string
A unique person identifier in the partner system. Mandatory for anonymous person, when the name, email, phoneNumber and personBusinessContext are empty
string
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
string
A unique identifier for the content in the partner”s system
string
The URL for the content the person looked at
string
The phone number of the person. Used for business context association
array
A list of tags defined for the content
string
The title of the content
string
The name of the company
string
The city of the person
string
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
string
The state of the person in ISO 3166-2. If not available in ISO 3166-2, then send as string
string
The region of the person in ISO 3166-2. If not available in ISO 3166-2, then send as string
string
The country of the person in ISO 3166. If not available in ISO 3166, then send as string
string
The company ID in the partner”s source system
array
Include additional custom data about the person
array
Include additional custom data about the content
string
The URL for additional details provided by the website or external app, such as analysis of the content viewed
string
The URL of the entity in the partner system
string
The name of the entity the person searched for
string
The current step the person is in, in the process
string
The domain of the entity
integer
The numeric value for the content
string
The ID of the entity in the partner system
integer
The highest value that can be given to the content
string
The ID of the object in the external system
string ("CATEGORY" | "PRODUCT" | "VENDOR")
The type of the entity the person searched for
array
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
integer
The lowest value that can be given to the content
string ("CONTACT" | "LEAD")
The object type in the external system
string
The name of the external system
string ("NPS" | "OTHER" | "PERCENTAGE" | "RATING")
The type of numeric value
array
A list of all available steps in the process

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_POST_DAY_BY_DAY_ACTIVITY_STATSRetrieve the daily activity of multiple users within the Gong system for a range of dates. This endpoint returns records including statistics about each user’s activity, on the daily level. Records are returned only for users with activity in the range. When accessed through a Bearer token authorization method, this endpoint requires the scope ‘api:stats:user-actions:detailed’.

Input Parameters

string
When paging is needed, provide the value supplied by the previous API call to bring the following page of records.
string
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.
array
Set of Gong”s unique numeric identifiers for the users (up to 20 digits).
string
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.
string
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’.
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_REGISTER_CRM_INTEGRATIONRegister a Generic CRM integration in Gong with a name and owner email, returning an integration ID for subsequent CRM API requests.

Input Parameters

string
required
The name of the integration
string
required
Email address of the person responsible for the integration

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_REPORT_CONTENT_SHARE_EVENTReport content share engagement events to Gong’s activity timeline when a Gong user shares content with external participants. The legacy Engagement API is a limited release.

Input Parameters

object
Information about the person who shared the content.
string
Unique identifier for the event.
string
Unique identifier for the share event.
string
required
Unique identifier for the content being shared.
string
The name of the action like “Contract Shared” or “Document Shared”.
string
required
Web address where the content is located.
array
Array of recipient objects with name and email. Email is required for each recipient.
string
Optional workspace identifier for event placement.
string
required
Name or title of the shared content.
string
required
When the sharing occurred in ISO-8601 format (e.g., ‘2025-12-15T10:30:00+00:00’).
string
required
Identifier of the system reporting the event.
string
The share message body text.
string
The subject of the share email or message.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_REPORT_CONTENT_VIEW_EVENTReport content view engagement events to Gong’s activity timeline when external participants view shared content. The legacy Engagement API is a limited release.

Input Parameters

object
Information about the viewer who accessed the content.
string
Original event identifier from the reporting system for deduplication.
string
Identifier for the content share action, if this view corresponds to a prior share event.
string
required
Unique identifier of the viewed content in the reporting system.
string
Browser ‘User-Agent’ header value from the viewing session.
string
The name of the action like “Document Viewed” or “Presentation Opened”.
string
required
The URL of the content that was accessed by the viewer.
string
Bundle identifier for mobile app interactions.
string
Link to additional information about the event.
string
Link presenting detailed event information.
integer
Optional Gong workspace numeric identifier for event placement.
string
required
Human-readable name or title of the content.
string
Platform where the interaction occurred (e.g., Windows, MacOS, iOS, Android).
string
required
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.
array
Additional properties related to the event.
string
required
Unique identifier of the system reporting the event.
string
Name describing the specific viewing action taken.
array
Additional properties/metadata associated with the content.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_REPORT_CUSTOM_ENGAGEMENT_EVENTReport custom engagement events to Gong’s activity timeline for external participants’ interactions with content. The legacy Engagement API is a limited release; bearer-token access requires the ‘api:engagement-data:write’ scope.

Input Parameters

string
The original id of the event as designated in the reporting system.
string
Unique identifier for the content share action, if this engagement corresponds to a prior share event.
string
The id of the content that was viewed in the reporting system.
string
“User-Agent” header value for browser based interaction
string
The name of the action like “Document Viewed” or “Presentation Opened”.
string
The url of the content that was viewed in the reporting system. This is the url that is was accessed by the viewer.
array
A list of references to external systems such as CRM, Telephony System, Case Management, etc.
string
The user id in Gong, if available.
string
Tracking identifier used for analytics or linking this event to other tracking systems.
string
The name of the person, if available.
string
The application identification string in case of interaction via mobile application (bundle identifier or package name).
string
URL to a page providing additional information or details about this engagement event.
string
Optional workspace identifier. If specified, the event will be placed into this workspace, otherwise, the default algorithm for workspace placement will be applied.
string
The email address of the person, if available.
string
The title of the person, if available.
string
Human readable title of the content.
string
The link to a page that presents additional information about this event.
string
The name of the person, if available.
string ("Windows, Linux, MacOS, iOS, Android")
Platform on which the interaction was made
string
The email address of the person, if available.
array
A list of links to external systems such as CRM, Telephony System, Case Management, etc.
string
required
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);
array
A list of additional properties for the event
string
required
The unique identifier of the reporting system. It is the same value in all events originating from the same system.
array
A list of additional properties for the content
string
Body text of the message used when sharing this content (e.g., email body).
string
Subject line of the message used when sharing this content (e.g., email subject).
array
List of non-company participants (external contacts) involved in this engagement event, such as prospects or customers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_RETRIEVE_CALL_DATA_BY_DATE_RANGE_V2_CALLSList calls that took place during a specified date range. When accessed through a Bearer token authorization method, this endpoint requires the scope ‘api:calls:read:basic’.

Input Parameters

string
When paging is needed, provide the value supplied by the previous API call to bring the following page of records.
string
required
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.
string
Optional Workspace identifier, if supplied the API will return only the calls belonging to this workspace.
string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_RETRIEVE_DATA_PRIVACY_INFO_FOR_EMAIL_ADDRESSRetrieves data privacy information for a third-party email address. Shows all elements in the Gong system that reference the given email address, including calls, email messages, meetings, customer data, and engagement events. This endpoint is designed for third-party privacy requests (e.g., customers, prospects, or external contacts) and will reject internal Gong user email addresses. When accessed through a Bearer token authorization, this endpoint requires the scope ‘api:data-privacy:read’.

Input Parameters

string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_RETRIEVE_FILTERED_CALL_DETAILSLists detailed call data filtered by date range, call IDs, workspace or host users; cursor requests cannot include filters. Bearer access requires api:calls:read:extensive, and requesting media URLs also requires api:calls:read:media-url.

Input Parameters

string
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.
array
List of calls Ids to be filtered. If not supplied, returns all calls between fromDateTime and toDateTime.
string
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.
string
Optional Workspace identifier, if supplied the API will return only the calls belonging to this workspace.
string
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.
array
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.
string ("Basic" | "Extended" | "None")
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”
array
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”
boolean
If true and exist, add audio url and video url of the call. The urls will be available for 8 hours.
boolean
If true, add information about the parties of the call
boolean
When true, returns the spotlight call brief.
boolean
If true, add duration of call topics
boolean
When true, returns the call outline.
boolean
If true, returns smart tracker and keyword tracker information for the call.
boolean
When true, returns the key points of the call.
boolean
If true, add call agenda, if available
boolean
If true, add video statistics
boolean
When true, returns the call highlights.
boolean
When true, returns the outcome of the call.
boolean
If true, add the time each participant spoke.
boolean
If true, add question counts
boolean
If true, add statistics for the host of the call.
boolean
If true, add call points of interest
boolean
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.
boolean
If true, add public comments made for this call

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_RETRIEVE_LIBRARY_FOLDERS_V2_LIBRARY_FOLDERSUse this endpoint to retrieve a list of public library folders. We do not allow retrieval of either private or archived folders. When accessed through a Bearer token authorization method, this endpoint requires the scope ‘api:library:read’.

Input Parameters

string
required
Workspace identifier. We will retrieve folders which are related to this specific workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_RETRIEVE_LOGS_DATA_BY_TYPE_AND_TIME_RANGE_V2_LOGSList log entries that took place during a specified time range. When accessed through a Bearer token authorization method, this endpoint requires the scope ‘api:logs:read’.

Input Parameters

string
When paging is needed, provide the value supplied by the previous API call to bring the following page of records.
string ("AccessLog" | "ExternallySharedCallAccess" | "ExternallySharedCallPlay" | "UserActivityLog" | "UserCallPlay")
required
Type of logs requested.
string
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.
string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_RETRIEVE_MANUAL_CRM_CALL_ASSOCIATIONSReturns a list of all calls that were manually associated or re-associated with CRM account and deal/opportunity since a given time. Actions will be listed in the ascending order of their timing. Notice if a call was associated and later re-associated the API will return both events. When accessed through a Bearer token authorization method, this endpoint requires the scope ‘api:crm-calls:manual-association:read’.

Input Parameters

string
When paging is needed, provide the value supplied by the previous API call to bring the following page of records.
string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_RETRIEVE_TRACKER_DETAILS_V2_SETTINGS_TRACKERSRetrieves details of all keyword trackers in the system or in a given workspace. When accessed through a Bearer token authorization method, this endpoint requires the ‘api:settings:trackers:read’ scope.

Input Parameters

string
The ID of the workspace the keyword trackers are in. When empty, all trackers in all workspaces are returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_RETRIEVE_TRANSCRIPTS_OF_CALLS_V2_CALLS_TRANSCRIPTDEPRECATED: Use GONG_GET_CALL_TRANSCRIPT instead. Returns transcripts for calls that took place during the specified date period. If call IDs are specified, only transcripts for calls with those IDs that took place during the time period are returned. When accessed through a Bearer token authorization method, this endpoint requires the scope ‘api:calls:read:transcript’.

Input Parameters

string
When paging is needed, provide the value supplied by the previous API call to bring the following page of records.
array
List of calls Ids to be filtered. If not supplied, returns all calls between fromDateTime and toDateTime.
string
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.
string
Optional Workspace identifier, if supplied the API will return only the calls belonging to this workspace.
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_RETRIEVE_USERS_FROM_PERMISSION_PROFILEReturns 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

string
required
Permission profile identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_SET_USER_CALL_ACCESSGive individual users access to calls. If a user already has access (perhaps the call was shared with them, or they have access through their permission profiles) the request will have no effect. When accessed through a Bearer token authorization method, this endpoint requires the scope ‘api:call-user-access:write’.

Input Parameters

array
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_UNASSIGN_FLOWS_BY_CRM_IDTool to unassign flows from prospects by their CRM Prospect ID. Use when you need to remove a prospect from specific flows or all flows in Gong Engage.

Input Parameters

string
The identifier of the flow to unassign the prospect from. If not provided, the prospect will be unassigned from all flows.
string
required
The CRM ID of the prospect to unassign from flows. This is the contact or lead ID from your CRM system.
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_UPDATE_A_GONG_MEETING_V2_MEETINGS_MEETING_IDUpdate a Gong meeting by ID. Bearer token access requires the ‘api:meetings:user:update’ scope.

Input Parameters

string
Title of the event.
string
required
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).
array
required
A list of email addresses of invitees to the event (not including the organizer).
integer
required
Gong”s unique identifier for the meeting (up to 20 digits).
string
required
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).
string
The ID as it is formed on the external system.
string
required
The email address of the user who created the meeting.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_UPDATE_PERMISSION_PROFILE_V2_PERMISSION_PROFILEUpdate a permission profile.

Input Parameters

string
Unique numeric identifier of the permission profile (up to 20 digits).
string
Permission profile name.
boolean
User can view deals pages.
boolean
User can view usage pages.
boolean
User can view market page.
boolean
User can view account pages.
boolean
User can view library pages.
boolean
User can view activity pages.
boolean
User can view coaching pages.
boolean
User can view forecast pages.
string
required
Permission profile identifier.
boolean
User can view team stats page.
boolean
User can trim calls.
boolean
User can score calls.
boolean
User can delete calls.
string
Permission profile description.
boolean
User can view initiatives page.
boolean
User can delete emails.
boolean
User can set their own calls as private.
boolean
User can perform import of crm data.
boolean
User can listen in calls.
boolean
User can override someone else score.
boolean
User can view and search calls.
boolean
User can manage forecast boards and upload targets.
boolean
User can manage scorecards.
boolean
User can download call media.
boolean
User can perform inline editing of deals.
boolean
User can perform inline editing of crm data.
boolean
User can view dashboards page.
boolean
User can manage revenue analytics.
boolean
User can share calls with customers.
array
List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API.
array
List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API.
array
List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API.
boolean
User can view engage analytics flows page.
array
List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API.
array
List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API.
array
List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API.
boolean
User can view engage analytics activity page.
string ("all" | "all / managers-team / report-to-them / own / none" | "managers-team" | "none" | "own" | "report-to-them")
Permission access scope.
string ("all" | "all / managers-team / report-to-them / own / none" | "managers-team" | "none" | "own" | "report-to-them")
Permission access scope.
boolean
User can manage company sequences.
boolean
User can manage company email templates.
string ("all" | "all / managers-team / report-to-them / own / none" | "managers-team" | "none" | "own" | "report-to-them")
Permission access scope.
string ("all" | "all / managers-team / report-to-them / own / none" | "managers-team" | "none" | "own" | "report-to-them")
Permission access scope.
boolean
User can create and manage rulesets.
boolean
User can manage general business settings.
boolean
User can create/edit/delete deals boards.
boolean
User can snooze flow in to dos for others
boolean
User can manually schedule and upload calls.
boolean
User can view engage analytics performance page.
string ("all" | "all / managers-team / report-to-them / own / none" | "managers-team" | "none" | "own" | "report-to-them")
Permission access scope.
boolean
User can export calls and coaching metrics data to CSV.
string ("all" | "all / managers-team / report-to-them / own / none" | "managers-team" | "none" | "own" | "report-to-them")
Permission access scope.
boolean
A user with this profile can manage streams, if set, “permissionLevel” must not be “none”.
string ("all" | "none" | "none, all, specific-folders" | "specific-folders")
Library folder permission level - mandatory value.
array
List of library folder Ids, if set, “permissionLevel” must not be “none”.
boolean
A user with this profile can add calls to folders, archive calls, if set, “permissionLevel” must not be “none”.
boolean
A user with this profile can manage public folder, if set, “permissionLevel” must not be “none”.
boolean
A user with this profile can share folders and streams from Your Library with other team members, if set, “permissionLevel” must not be “none”.
array
List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API.
string ("all" | "all / managers-team / report-to-them / own / none" | "managers-team" | "none" | "own" | "report-to-them")
Permission access scope.
array
List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API.
array
List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API.
string ("all" | "all / managers-team / report-to-them / own / none" | "managers-team" | "none" | "own" | "report-to-them")
Permission access scope.
string ("all" | "all / managers-team / report-to-them / own / none" | "managers-team" | "none" | "own" | "report-to-them")
Permission access scope.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_UPLOAD_CRM_OBJECTS_V2_CRM_ENTITIESUploads CRM entity data to Gong via LDJSON file. Use this to insert, update, or delete CRM entities (Accounts, Contacts, Deals, Leads, Stages, Business Users) in Gong’s platform. The file should be in LDJSON format (Line-Delimited JSON) where each line is a separate JSON object representing one entity. Each entity object must include ‘objectId’ (unique CRM ID), ‘objectType’ (matching the objectType parameter), and ‘fields’ (array of name-value pairs for entity attributes). Maximum file size is 200MB. After upload, use the returned requestId with /v2/crm/request-status to check processing status. Requires ‘api:crm:upload’ scope and a registered CRM integration (via /v2/crm/integrations).

Input Parameters

object
required
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.
string
required
The type of CRM entity being uploaded. Valid values: ACCOUNT, CONTACT, DEAL, LEAD, STAGE, BUSINESS_USER
integer
required
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.
string
A unique identifier for this request, used for tracking and troubleshooting purposes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GONG_VALIDATE_MEETING_INTEGRATIONValidates Gong meeting integration status for one or more users by their email addresses. This endpoint checks if users have their meeting integration properly configured in Gong. Returns status information including whether users exist, if their integration is valid, and any error messages with help/fix URLs if issues are found. Use this when you need to: - Verify meeting integration is working for specific users - Diagnose meeting recording or import issues - Check if users are properly set up to use Gong meeting features - Troubleshoot why meetings aren’t being captured for certain users Note: The API returns an empty array when all specified users have valid integration or when users don’t have meeting integration issues to report.

Input Parameters

array
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not