Use Gong to list calls, read call details and transcripts, and retrieve topics, trackers, interaction statistics, and other extensive call data. The actions also read users, activity and coaching metrics, answered scorecards, scorecard definitions, tracker configuration, call-library folders and content, and Engage flows.
Look up an email address or phone number to find related calls, emails, meetings, CRM records, and engagement events. Connect your Gong API credentials and inspect the returned data when preparing coaching reports or syncing conversations to another system.
Create Call uploads metadata and asks Gong to fetch the recording from a media URL. Assign Flow Prospects and Unassign Flow Prospects change a prospect’s Engage flow assignments. Purge Email Address and Purge Phone Number request deletion of associated Gong data. Gong processes these deletions in the background ; a returned request ID does not confirm completion.
Read calls, recording URLs, transcripts, user data, activity statistics, scorecards, trackers, library content, coaching metrics, and Engage flows. Upload call metadata and let Gong fetch the media URL, assign or unassign flow prospects, and request data erasure for an email address or phone number.
Retrieve call data by date range from Gong.
Inputs and outputsParameter Type Required Description accessKeystring Yes Gong API Access Key accessKeySecretstring Yes Gong API Access Key Secret fromDateTimestring Yes Start date/time in ISO-8601 format (e.g., 2024-01-01T00:00:00Z) toDateTimestring No End date/time in ISO-8601 format (e.g., 2024-01-31T23:59:59Z). Defaults to the current execution time when omitted. cursorstring No Pagination cursor from a previous response workspaceIdstring No Gong workspace ID to filter calls
Parameter Type Description requestIdstring A Gong request reference ID for troubleshooting purposes callsarray List of calls matching the date range ↳ id string Gong's unique numeric identifier for the call ↳ title string Call title ↳ scheduled string Scheduled call time in ISO-8601 format ↳ started string Recording start time in ISO-8601 format ↳ duration number Call duration in seconds ↳ direction string Call direction (Inbound/Outbound) ↳ system string Communication platform used (e.g., Outreach) ↳ scope string Call scope: 'Internal', 'External', or 'Unknown' ↳ media string Media type (e.g., Video) ↳ language string Language code in ISO-639-2B format ↳ url string URL to the call in the Gong web app ↳ primaryUserId string Host team member identifier ↳ workspaceId string Workspace identifier ↳ sdrDisposition string SDR disposition classification ↳ clientUniqueId string Call identifier from the origin recording system ↳ customData string Metadata provided during call creation ↳ purpose string Call purpose ↳ meetingUrl string Web conference provider URL ↳ isPrivate boolean Whether the call is private ↳ calendarEventId string Calendar event identifier cursorstring Pagination cursor for the next page totalRecordsnumber Total number of records matching the filter currentPageSizenumber Number of records in the current page currentPageNumbernumber Current page number
Upload call metadata to Gong and let Gong pull the media from a URL.
Inputs and outputsParameter Type Required Description accessKeystring Yes Gong API Access Key accessKeySecretstring Yes Gong API Access Key Secret clientUniqueIdstring Yes Unique call ID from the source telephony or recording system actualStartstring Yes Actual call start time in ISO-8601 format primaryUserstring Yes Gong user ID for the call's host or owner partiesjson Yes Array of call parties, with at least the primary user included directionstring Yes Call direction: Inbound, Outbound, Conference, or Unknown downloadMediaUrlstring No URL where Gong can download the call media file. If omitted, the call is created without media and Gong waits for a separate media upload. titlestring No Human-readable call title workspaceIdstring No Optional Gong workspace ID dispositionstring No Optional call disposition purposestring No Optional call purpose contextjson No Optional CRM context array for the call callProviderCodestring No Optional conferencing or telephony provider code
Parameter Type Description callIdstring Gong's unique numeric identifier for the created call requestIdstring Gong request reference ID for troubleshooting
Retrieve detailed data for a specific call from Gong.
Inputs and outputsParameter Type Required Description accessKeystring Yes Gong API Access Key accessKeySecretstring Yes Gong API Access Key Secret callIdstring Yes The Gong call ID to retrieve
Parameter Type Description requestIdstring A Gong request reference ID for troubleshooting purposes idstring Gong's unique numeric identifier for the call titlestring Call title urlstring URL to the call in the Gong web app scheduledstring Scheduled call time in ISO-8601 format startedstring Recording start time in ISO-8601 format durationnumber Call duration in seconds directionstring Call direction (Inbound/Outbound) systemstring Communication platform used (e.g., Outreach) scopestring Call scope: 'Internal', 'External', or 'Unknown' mediastring Media type (e.g., Video) languagestring Language code in ISO-639-2B format primaryUserIdstring Host team member identifier workspaceIdstring Workspace identifier sdrDispositionstring SDR disposition classification clientUniqueIdstring Call identifier from the origin recording system customDatastring Metadata provided during call creation purposestring Call purpose meetingUrlstring Web conference provider URL isPrivateboolean Whether the call is private calendarEventIdstring Calendar event identifier
Retrieve transcripts of calls from Gong by call IDs or date range.
Inputs and outputsParameter Type Required Description accessKeystring Yes Gong API Access Key accessKeySecretstring Yes Gong API Access Key Secret callIdsstring No Comma-separated list of call IDs to retrieve transcripts for fromDateTimestring No Start date/time filter in ISO-8601 format toDateTimestring No End date/time filter in ISO-8601 format workspaceIdstring No Gong workspace ID to filter calls cursorstring No Pagination cursor from a previous response
Parameter Type Description requestIdstring A Gong request reference ID for troubleshooting purposes callTranscriptsarray List of call transcripts with speaker turns and sentences ↳ callId string Gong's unique numeric identifier for the call ↳ transcript array List of monologues in the call ↳ speakerId string Unique ID of the speaker, cross-reference with parties ↳ topic string Name of the topic being discussed ↳ sentences array List of sentences spoken in the monologue ↳ start number Start time of the sentence in milliseconds from call start ↳ end number End time of the sentence in milliseconds from call start ↳ text string The sentence text cursorstring Pagination cursor for the next page
Retrieve detailed call data including trackers, topics, highlights, and AI spotlight content (brief, outline, key points, call outcome) from Gong.
Inputs and outputsParameter Type Required Description accessKeystring Yes Gong API Access Key accessKeySecretstring Yes Gong API Access Key Secret callIdsstring No Comma-separated list of call IDs to retrieve detailed data for fromDateTimestring No Start date/time filter in ISO-8601 format toDateTimestring No End date/time filter in ISO-8601 format workspaceIdstring No Gong workspace ID to filter calls primaryUserIdsstring No Comma-separated list of user IDs to filter calls by host cursorstring No Pagination cursor from a previous response
Parameter Type Description requestIdstring A Gong request reference ID for troubleshooting purposes callsarray List of detailed call objects with metadata, content, interaction stats, and collaboration data ↳ metaData object Call metadata (same fields as CallBasicData) ↳ id string Call ID ↳ title string Call title ↳ scheduled string Scheduled time in ISO-8601 ↳ started string Start time in ISO-8601 ↳ duration number Duration in seconds ↳ direction string Call direction ↳ system string Communication platform ↳ scope string Internal/External/Unknown ↳ media string Media type ↳ language string Language code (ISO-639-2B) ↳ url string Gong web app URL ↳ primaryUserId string Host user ID ↳ workspaceId string Workspace ID ↳ sdrDisposition string SDR disposition ↳ clientUniqueId string Origin system call ID ↳ customData string Custom metadata ↳ purpose string Call purpose ↳ meetingUrl string Meeting URL ↳ isPrivate boolean Whether call is private ↳ calendarEventId string Calendar event ID ↳ context array Links to external systems (CRM, Dialer, etc.) ↳ system string External system name (e.g., Salesforce) ↳ objects array List of objects within the external system ↳ parties array List of call participants ↳ id string Unique participant ID in the call ↳ name string Participant name ↳ emailAddress string Email address ↳ title string Job title ↳ phoneNumber string Phone number ↳ speakerId string Speaker ID for transcript cross-reference ↳ userId string Gong user ID ↳ affiliation string Company or non-company ↳ methods array Whether invited or attended ↳ context array Links to external systems for this party ↳ content object Call content data ↳ brief string AI-generated brief summary of the call (Call Spotlight) ↳ outline array AI-generated call outline sections ↳ section string Outline section name ↳ startTime number Section start in seconds from call start ↳ duration number Section duration in seconds ↳ items array Bullet items within the section ↳ keyPoints array AI-generated key points of the call ↳ text string Key point text ↳ callOutcome object AI-determined call outcome (Call Spotlight) ↳ id string Outcome category ID ↳ category string Outcome category name ↳ name string Outcome name ↳ structure array Call agenda parts ↳ name string Agenda name ↳ duration number Duration of this part in seconds ↳ topics array Topics and their durations ↳ name string Topic name (e.g., Pricing) ↳ duration number Time spent on topic in seconds ↳ trackers array Trackers found in the call ↳ id string Tracker ID ↳ name string Tracker name ↳ count number Number of occurrences ↳ type string Keyword or Smart ↳ occurrences array Details for each occurrence ↳ speakerId string Speaker who said it ↳ startTime number Seconds from call start ↳ phrases array Per-phrase occurrence counts ↳ phrase string Specific phrase ↳ count number Occurrences of this phrase ↳ occurrences array Details per occurrence ↳ highlights array AI-generated highlights including next steps, action items, and key moments ↳ title string Title of the highlight ↳ items array Individual highlight items ↳ text string Text of the highlight item ↳ startTimes array Start times in seconds from call start ↳ interaction object Interaction statistics ↳ interactionStats array Interaction stat measurements (Longest Monologue, Interactivity, Patience, etc.) ↳ name string Stat name ↳ value number Stat value ↳ speakers array Talk duration per speaker ↳ id string Participant ID ↳ userId string Gong user ID ↳ talkTime number Talk duration in seconds ↳ video array Video statistics ↳ name string Segment type: Browser, Presentation, WebcamPrimaryUser, WebcamNonCompany, Webcam ↳ duration number Total segment duration in seconds ↳ questions object Question counts ↳ companyCount number Questions by company speakers ↳ nonCompanyCount number Questions by non-company speakers ↳ collaboration object Collaboration data ↳ publicComments array Public comments on the call ↳ id string Comment ID ↳ commenterUserId string Commenter user ID ↳ comment string Comment text ↳ posted string Posted time in ISO-8601 ↳ audioStartTime number Seconds from call start the comment refers to ↳ audioEndTime number Seconds from call start the comment end refers to ↳ duringCall boolean Whether the comment was posted during the call ↳ inReplyTo string ID of original comment if this is a reply ↳ media object Media download URLs (available for 8 hours) ↳ audioUrl string Audio download URL ↳ videoUrl string Video download URL cursorstring Pagination cursor for the next page
List all users in your Gong account.
Inputs and outputsParameter Type Required Description accessKeystring Yes Gong API Access Key accessKeySecretstring Yes Gong API Access Key Secret cursorstring No Pagination cursor from a previous response includeAvatarsstring No Whether to include avatar URLs (true/false)
Parameter Type Description requestIdstring A Gong request reference ID for troubleshooting purposes usersarray List of Gong users ↳ id string Unique numeric user ID (up to 20 digits) ↳ emailAddress string User email address ↳ created string User creation timestamp (ISO-8601) ↳ active boolean Whether the user is active ↳ emailAliases array Alternative email addresses for the user ↳ trustedEmailAddress string Trusted email address for the user ↳ firstName string First name ↳ lastName string Last name ↳ title string Job title ↳ phoneNumber string Phone number ↳ extension string Phone extension number ↳ personalMeetingUrls array Personal meeting URLs ↳ settings object User settings ↳ webConferencesRecorded boolean Whether web conferences are recorded ↳ preventWebConferenceRecording boolean Whether web conference recording is prevented ↳ telephonyCallsImported boolean Whether telephony calls are imported ↳ emailsImported boolean Whether emails are imported ↳ preventEmailImport boolean Whether email import is prevented ↳ nonRecordedMeetingsImported boolean Whether non-recorded meetings are imported ↳ gongConnectEnabled boolean Whether Gong Connect is enabled ↳ managerId string Manager user ID ↳ meetingConsentPageUrl string Meeting consent page URL ↳ spokenLanguages array Languages spoken by the user ↳ language string Language code ↳ primary boolean Whether this is the primary language cursorstring Pagination cursor for the next page totalRecordsnumber Total number of user records currentPageSizenumber Number of records in the current page currentPageNumbernumber Current page number
Retrieve details for a specific user from Gong.
Inputs and outputsParameter Type Required Description accessKeystring Yes Gong API Access Key accessKeySecretstring Yes Gong API Access Key Secret userIdstring Yes The Gong user ID to retrieve
Parameter Type Description requestIdstring A Gong request reference ID for troubleshooting purposes idstring Unique numeric user ID (up to 20 digits) emailAddressstring User email address createdstring User creation timestamp (ISO-8601) activeboolean Whether the user is active emailAliasesarray Alternative email addresses for the user trustedEmailAddressstring Trusted email address for the user firstNamestring First name lastNamestring Last name titlestring Job title phoneNumberstring Phone number extensionstring Phone extension number personalMeetingUrlsarray Personal meeting URLs settingsobject User settings ↳ webConferencesRecorded boolean Whether web conferences are recorded ↳ preventWebConferenceRecording boolean Whether web conference recording is prevented ↳ telephonyCallsImported boolean Whether telephony calls are imported ↳ emailsImported boolean Whether emails are imported ↳ preventEmailImport boolean Whether email import is prevented ↳ nonRecordedMeetingsImported boolean Whether non-recorded meetings are imported ↳ gongConnectEnabled boolean Whether Gong Connect is enabled managerIdstring Manager user ID meetingConsentPageUrlstring Meeting consent page URL spokenLanguagesarray Languages spoken by the user ↳ language string Language code ↳ primary boolean Whether this is the primary language
Retrieve aggregated activity statistics for users by date range from Gong.
Inputs and outputsParameter Type Required Description accessKeystring Yes Gong API Access Key accessKeySecretstring Yes Gong API Access Key Secret userIdsstring No Comma-separated list of Gong user IDs (up to 20 digits each) fromDatestring Yes Start date in YYYY-MM-DD format (inclusive, in company timezone) toDatestring Yes End date in YYYY-MM-DD format (exclusive, in company timezone, cannot exceed current day) cursorstring No Pagination cursor from a previous response
Parameter Type Description requestIdstring A Gong request reference ID for troubleshooting purposes usersActivityarray Aggregated activity statistics per user ↳ userId string Gong's unique numeric identifier for the user ↳ userEmailAddress string Email address of the Gong user ↳ callsAsHost number Number of recorded calls this user hosted ↳ callsAttended number Number of calls where this user was a participant (not host) ↳ callsGaveFeedback number Number of recorded calls the user gave feedback on ↳ callsReceivedFeedback number Number of recorded calls the user received feedback on ↳ callsRequestedFeedback number Number of recorded calls the user requested feedback on ↳ callsScorecardsFilled number Number of scorecards the user completed ↳ callsScorecardsReceived number Number of calls where someone filled a scorecard on the user's calls ↳ ownCallsListenedTo number Number of the user's own calls the user listened to ↳ othersCallsListenedTo number Number of other users' calls the user listened to ↳ callsSharedInternally number Number of calls the user shared internally ↳ callsSharedExternally number Number of calls the user shared externally ↳ callsCommentsGiven number Number of calls where the user provided at least one comment ↳ callsCommentsReceived number Number of calls where the user received at least one comment ↳ callsMarkedAsFeedbackGiven number Number of calls where the user selected Mark as reviewed ↳ callsMarkedAsFeedbackReceived number Number of calls where others selected Mark as reviewed on the user's calls timeZonestring The company's defined timezone in Gong fromDateTimestring Start of results in ISO-8601 format toDateTimestring End of results in ISO-8601 format cursorstring Pagination cursor for the next page
Retrieve detailed day-by-day activity (call IDs per activity type) for users by date range from Gong.
Inputs and outputsParameter Type Required Description accessKeystring Yes Gong API Access Key accessKeySecretstring Yes Gong API Access Key Secret userIdsstring No Comma-separated list of Gong user IDs (up to 20 digits each) fromDatestring Yes Start date in YYYY-MM-DD format (inclusive, in company timezone) toDatestring Yes End date in YYYY-MM-DD format (exclusive, in company timezone, cannot exceed current day) cursorstring No Pagination cursor from a previous response
Parameter Type Description requestIdstring A Gong request reference ID for troubleshooting purposes usersDetailedActivitiesarray Day-by-day activity per user, with call IDs grouped by activity type ↳ userId string Gong's unique numeric identifier for the user ↳ userEmailAddress string Email address of the Gong user ↳ userDailyActivityStats array One record per day in the date range ↳ fromDate string Start of the day (ISO-8601) ↳ toDate string End of the day (ISO-8601) ↳ callsAsHost array IDs of calls the user hosted ↳ callsAttended array IDs of calls the user attended (not host) ↳ callsGaveFeedback array IDs of calls the user gave feedback on ↳ callsReceivedFeedback array IDs of calls the user received feedback on ↳ callsRequestedFeedback array IDs of calls the user requested feedback on ↳ callsScorecardsFilled array IDs of calls the user filled scorecards on ↳ callsScorecardsReceived array IDs of the user's calls that received a scorecard ↳ ownCallsListenedTo array IDs of the user's own calls the user listened to ↳ othersCallsListenedTo array IDs of other users' calls the user listened to ↳ callsSharedInternally array IDs of calls the user shared internally ↳ callsSharedExternally array IDs of calls the user shared externally ↳ callsCommentsGiven array IDs of calls the user commented on ↳ callsCommentsReceived array IDs of the user's calls that received a comment ↳ callsMarkedAsFeedbackGiven array IDs of calls the user marked as reviewed ↳ callsMarkedAsFeedbackReceived array IDs of the user's calls marked as reviewed by others cursorstring Pagination cursor for the next page
Retrieve aggregated user activity grouped into time periods (day, week, month, quarter, year) by date range from Gong.
Inputs and outputsParameter Type Required Description accessKeystring Yes Gong API Access Key accessKeySecretstring Yes Gong API Access Key Secret aggregationPeriodstring Yes Calendar period to group activity by: DAY, WEEK, MONTH, QUARTER, or YEAR (week starts Monday) userIdsstring No Comma-separated list of Gong user IDs (up to 20 digits each) fromDatestring Yes Start date in YYYY-MM-DD format (inclusive, in company timezone) toDatestring Yes End date in YYYY-MM-DD format (exclusive, in company timezone, cannot exceed current day) cursorstring No Pagination cursor from a previous response
Parameter Type Description requestIdstring A Gong request reference ID for troubleshooting purposes usersAggregateActivityarray Aggregated activity per user, one item per consecutive time period in the range ↳ userId string Gong's unique numeric identifier for the user ↳ userEmailAddress string Email address of the Gong user ↳ userAggregateActivity array Activity counts per time period ↳ fromDate string Start of the period (ISO-8601) ↳ toDate string End of the period (ISO-8601) ↳ callsAsHost number Calls the user hosted ↳ callsAttended number Calls the user attended (not host) ↳ callsGaveFeedback number Calls the user gave feedback on ↳ callsReceivedFeedback number Calls the user received feedback on ↳ callsRequestedFeedback number Calls the user requested feedback on ↳ callsScorecardsFilled number Scorecards the user completed ↳ callsScorecardsReceived number Calls where someone filled a scorecard on the user's calls ↳ ownCallsListenedTo number The user's own calls the user listened to ↳ othersCallsListenedTo number Other users' calls the user listened to ↳ callsSharedInternally number Calls the user shared internally ↳ callsSharedExternally number Calls the user shared externally ↳ callsCommentsGiven number Calls the user commented on ↳ callsCommentsReceived number Calls where the user's calls received a comment ↳ callsMarkedAsFeedbackGiven number Calls the user marked as reviewed ↳ callsMarkedAsFeedbackReceived number The user's calls marked as reviewed by others cursorstring Pagination cursor for the next page
Retrieve interaction statistics for users by date range from Gong. Only includes calls with Whisper enabled.
Inputs and outputsParameter Type Required Description accessKeystring Yes Gong API Access Key accessKeySecretstring Yes Gong API Access Key Secret userIdsstring No Comma-separated list of Gong user IDs (up to 20 digits each) fromDatestring Yes Start date in YYYY-MM-DD format (inclusive, in company timezone) toDatestring Yes End date in YYYY-MM-DD format (exclusive, in company timezone, cannot exceed current day) cursorstring No Pagination cursor from a previous response
Parameter Type Description requestIdstring A Gong request reference ID for troubleshooting purposes peopleInteractionStatsarray Interaction statistics per user. Applicable stat names: 'Longest Monologue', 'Longest Customer Story', 'Interactivity', 'Patience', 'Question Rate'. ↳ userId string Gong's unique numeric identifier for the user ↳ userEmailAddress string Email address of the Gong user ↳ personInteractionStats array List of interaction stat measurements for this user ↳ name string Stat name (e.g. Longest Monologue, Interactivity, Patience, Question Rate) ↳ value number Stat measurement value (can be double or integer) timeZonestring The company's defined timezone in Gong fromDateTimestring Start of results in ISO-8601 format toDateTimestring End of results in ISO-8601 format cursorstring Pagination cursor for the next page
Retrieve answered scorecards for reviewed users or by date range from Gong.
Inputs and outputsParameter Type Required Description accessKeystring Yes Gong API Access Key accessKeySecretstring Yes Gong API Access Key Secret callFromDatestring No Start date for calls in YYYY-MM-DD format (inclusive, in company timezone). Defaults to earliest recorded call. callToDatestring No End date for calls in YYYY-MM-DD format (exclusive, in company timezone). Defaults to latest recorded call. reviewFromDatestring No Start date for reviews in YYYY-MM-DD format (inclusive, in company timezone). Defaults to earliest reviewed call. reviewToDatestring No End date for reviews in YYYY-MM-DD format (exclusive, in company timezone). Defaults to latest reviewed call. scorecardIdsstring No Comma-separated list of scorecard IDs to filter by reviewedUserIdsstring No Comma-separated list of reviewed user IDs to filter by cursorstring No Pagination cursor from a previous response
Parameter Type Description requestIdstring A Gong request reference ID for troubleshooting purposes answeredScorecardsarray List of answered scorecards with scores and answers ↳ answeredScorecardId number Identifier of the answered scorecard ↳ scorecardId number Identifier of the scorecard ↳ scorecardName string Scorecard name ↳ callId number Gong's unique numeric identifier for the call ↳ callStartTime string Date/time of the call in ISO-8601 format ↳ reviewedUserId number User ID of the team member being reviewed ↳ reviewerUserId number User ID of the team member who completed the scorecard ↳ reviewTime string Date/time when the review was completed in ISO-8601 format ↳ visibilityType string Visibility type of the scorecard answer ↳ answers array Answers in the answered scorecard ↳ questionId number Identifier of the question ↳ questionRevisionId number Identifier of the revision version of the question ↳ isOverall boolean Whether this is the overall question ↳ score number Score between 1 to 50 if answered, null otherwise ↳ answerText string The answer's text if answered, null otherwise ↳ notApplicable boolean Whether the question is not applicable to this call ↳ selectedOptions array Identifiers of the options selected for select-type questions, null otherwise cursorstring Pagination cursor for the next page
Retrieve library folders from Gong.
Inputs and outputsParameter Type Required Description accessKeystring Yes Gong API Access Key accessKeySecretstring Yes Gong API Access Key Secret workspaceIdstring No Gong workspace ID to filter folders
Parameter Type Description requestIdstring A Gong request reference ID for troubleshooting purposes foldersarray List of library folders with id, name, and parent relationships ↳ id string Gong unique numeric identifier for the folder ↳ name string Display name of the folder ↳ parentFolderId string Gong unique numeric identifier for the parent folder (null for root folder) ↳ createdBy string Gong unique numeric identifier for the user who added the folder ↳ updated string Folder's last update time in ISO-8601 format
Retrieve the list of calls in a specific library folder from Gong.
Inputs and outputsParameter Type Required Description accessKeystring Yes Gong API Access Key accessKeySecretstring Yes Gong API Access Key Secret folderIdstring No The library folder ID to retrieve content for (up to 20 digits)
Parameter Type Description requestIdstring A Gong request reference ID for troubleshooting purposes folderIdstring Gong's unique numeric identifier for the folder folderNamestring Display name of the folder createdBystring Gong's unique numeric identifier for the user who added the folder updatedstring Folder's last update time in ISO-8601 format callsarray List of calls in the library folder ↳ id string Gong unique numeric identifier of the call ↳ title string The title of the call ↳ note string A note attached to the call in the folder ↳ addedBy string Gong unique numeric identifier for the user who added the call ↳ created string Date and time the call was added to folder in ISO-8601 format ↳ url string URL of the call ↳ snippet object Call snippet time range ↳ fromSec number Snippet start in seconds relative to call start ↳ toSec number Snippet end in seconds relative to call start
Retrieve scorecard definitions from Gong settings.
Inputs and outputsParameter Type Required Description accessKeystring Yes Gong API Access Key accessKeySecretstring Yes Gong API Access Key Secret
Parameter Type Description requestIdstring A Gong request reference ID for troubleshooting purposes scorecardsarray List of scorecard definitions with questions ↳ scorecardId number Unique identifier for the scorecard ↳ scorecardName string Display name of the scorecard ↳ workspaceId number Workspace identifier associated with this scorecard ↳ enabled boolean Whether the scorecard is active ↳ updaterUserId number ID of the user who last modified the scorecard ↳ created string Creation timestamp in ISO-8601 format ↳ updated string Last update timestamp in ISO-8601 format ↳ reviewMethod string Review method configured for the scorecard ↳ questions array List of questions in the scorecard ↳ questionId number Unique identifier for the question ↳ questionRevisionId number Identifier for the specific revision of the question ↳ questionText string The text content of the question ↳ isOverall boolean Whether this is the primary overall question ↳ questionType string The type of the question (e.g. range or select) ↳ answerGuide string Guidance text describing how to answer the question ↳ minRange number Minimum score for range-type questions ↳ maxRange number Maximum score for range-type questions ↳ answerOptions array Selectable options for select-type questions ↳ id number Identifier of the option ↳ text string Display text of the option
Retrieve smart tracker and keyword tracker definitions from Gong settings.
Inputs and outputsParameter Type Required Description accessKeystring Yes Gong API Access Key accessKeySecretstring Yes Gong API Access Key Secret workspaceIdstring No The ID of the workspace the keyword trackers are in. When empty, all trackers in all workspaces are returned.
Parameter Type Description requestIdstring A Gong request reference ID for troubleshooting purposes trackersarray List of keyword tracker definitions ↳ trackerId string Unique identifier for the tracker ↳ trackerName string Display name of the tracker ↳ workspaceId string ID of the workspace containing the tracker ↳ languageKeywords array Keywords organized by language ↳ language string ISO 639-2/B language code ("mul" means keywords apply across all languages) ↳ keywords array Words and phrases in the designated language ↳ includeRelatedForms boolean Whether to include different word forms ↳ affiliation string Speaker affiliation filter: "Anyone", "Company", or "NonCompany" ↳ partOfQuestion boolean Whether to track keywords only within questions ↳ saidAt string Position in call: "Anytime", "First", or "Last" ↳ saidAtInterval number Duration to search (in minutes or percentage) ↳ saidAtUnit string Unit for saidAtInterval ↳ saidInTopics array Topics where keywords should be detected ↳ filterQuery string JSON-formatted call filtering criteria ↳ created string Creation timestamp in ISO-8601 format ↳ creatorUserId string ID of the user who created the tracker (null for built-in trackers) ↳ updated string Last modification timestamp in ISO-8601 format ↳ updaterUserId string ID of the user who last modified the tracker
List all company workspaces in Gong.
Inputs and outputsParameter Type Required Description accessKeystring Yes Gong API Access Key accessKeySecretstring Yes Gong API Access Key Secret
Parameter Type Description requestIdstring A Gong request reference ID for troubleshooting purposes workspacesarray List of Gong workspaces ↳ id string Gong unique numeric identifier for the workspace ↳ name string Display name of the workspace ↳ description string Description of the workspace's purpose or content
List Gong Engage flows (sales engagement sequences).
Inputs and outputsParameter Type Required Description accessKeystring Yes Gong API Access Key accessKeySecretstring Yes Gong API Access Key Secret flowOwnerEmailstring Yes Email of a Gong user. The API will return 'PERSONAL' flows belonging to this user in addition to 'COMPANY' flows. workspaceIdstring No Optional workspace ID to filter flows to a specific workspace cursorstring No Pagination cursor from a previous API call to retrieve the next page of records
Parameter Type Description requestIdstring A Gong request reference ID for troubleshooting purposes flowsarray List of Gong Engage flows ↳ id string The ID of the flow ↳ name string The name of the flow ↳ folderId string The ID of the folder this flow is under ↳ folderName string The name of the folder this flow is under ↳ visibility string The flow visibility type (COMPANY, PERSONAL, or SHARED) ↳ creationDate string Creation time of the flow in ISO-8601 format ↳ exclusive boolean Indicates whether a prospect in this flow can be added to other flows totalRecordsnumber Total number of flow records available currentPageSizenumber Number of records returned in the current page currentPageNumbernumber Current page number cursorstring Pagination cursor for retrieving the next page of records
Assign up to 200 CRM prospects (contacts or leads) to a Gong Engage flow.
Inputs and outputsParameter Type Required Description accessKeystring Yes Gong API Access Key accessKeySecretstring Yes Gong API Access Key Secret flowIdstring Yes The Gong Engage flow ID to assign the prospects to crmProspectsIdsstring Yes Comma-separated list of CRM prospect IDs (contacts or leads) to assign flowInstanceOwnerEmailstring Yes Email of the Gong user who owns the flow instance and its to-dos
Parameter Type Description requestIdstring A Gong request reference ID for troubleshooting purposes prospectsAssignedarray Prospects successfully assigned to the flow ↳ flowId string The flow ID ↳ flowName string The flow name ↳ crmProspectId string The CRM prospect ID ↳ flowInstanceId string The created flow instance ID ↳ flowInstanceOwnerEmail string Email of the flow instance owner ↳ flowInstanceOwnerFullName string Full name of the flow instance owner ↳ flowInstanceCreateDate string Creation time of the flow instance in ISO-8601 format ↳ flowInstanceStatus string Status of the flow instance ↳ workspaceId string Workspace ID ↳ exclusive boolean Whether this prospect can be added to other flows prospectsNotAssignedarray Prospects that failed to be assigned to the flow ↳ flowId string The flow ID ↳ crmProspectId string The CRM prospect ID ↳ errorCode string Failure reason: InvalidArgument, InvalidState, or UnexpectedError ↳ errorMessage string Human-readable failure message
Remove a prospect from Gong Engage flows. Omit the flow ID to remove the prospect from all flows they are assigned to.
Inputs and outputsParameter Type Required Description accessKeystring Yes Gong API Access Key accessKeySecretstring Yes Gong API Access Key Secret crmProspectIdstring Yes The CRM ID of the prospect to unassign flowIdstring No The ID of the flow to unassign the prospect from. If omitted, the prospect is removed from all flows they are assigned to. unassignedByUserEmailstring No Email address of the Gong user requesting to remove the prospect from the flow
Parameter Type Description requestIdstring A Gong request reference ID for troubleshooting purposes unassignedFlowInstanceIdsarray IDs of the flow instances the prospect was successfully removed from
Get the Gong Engage flows currently assigned to the given CRM prospects.
Inputs and outputsParameter Type Required Description accessKeystring Yes Gong API Access Key accessKeySecretstring Yes Gong API Access Key Secret crmProspectsIdsstring Yes Comma-separated list of CRM prospect IDs (contacts or leads) to look up
Parameter Type Description requestIdstring A Gong request reference ID for troubleshooting purposes prospectsAssignedarray Flows currently assigned to the requested prospects ↳ flowId string The flow ID ↳ flowName string The flow name ↳ crmProspectId string The CRM prospect ID ↳ flowInstanceId string The flow instance ID ↳ flowInstanceOwnerEmail string Email of the flow instance owner ↳ flowInstanceOwnerFullName string Full name of the flow instance owner ↳ flowInstanceCreateDate string Creation time of the flow instance in ISO-8601 format ↳ flowInstanceStatus string Status of the flow instance ↳ workspaceId string Workspace ID ↳ exclusive boolean Whether this prospect can be added to other flows
Retrieve coaching metrics for a manager from Gong.
Inputs and outputsParameter Type Required Description accessKeystring Yes Gong API Access Key accessKeySecretstring Yes Gong API Access Key Secret managerIdstring Yes Gong user ID of the manager workspaceIdstring Yes Gong workspace ID fromDatestring Yes Start date in ISO-8601 format toDatestring Yes End date in ISO-8601 format
Parameter Type Description requestIdstring A Gong request reference ID for troubleshooting purposes coachingDataarray A list of coaching data entries, one per manager's team ↳ manager object The manager user information ↳ id string Gong unique numeric identifier for the user ↳ emailAddress string Email address of the Gong user ↳ firstName string First name of the Gong user ↳ lastName string Last name of the Gong user ↳ title string Job title of the Gong user ↳ directReportsMetrics array Coaching metrics for each direct report ↳ report object The direct report user information ↳ id string Gong unique numeric identifier for the user ↳ emailAddress string Email address of the Gong user ↳ firstName string First name of the Gong user ↳ lastName string Last name of the Gong user ↳ title string Job title of the Gong user ↳ metrics json A map of metric names to arrays of string values representing coaching metrics
Ask a natural-language question about a CRM account, deal, contact, or lead. Gong answers from up to 60 calls and 500 emails associated with the entity. Consumes Gong credits.
Inputs and outputsParameter Type Required Description accessKeystring Yes Gong API Access Key accessKeySecretstring Yes Gong API Access Key Secret workspaceIdstring Yes Gong workspace ID the entity belongs to crmEntityTypestring Yes Type of the CRM entity: ACCOUNT, CONTACT, DEAL, or LEAD crmEntityIdstring Yes The CRM ID of the entity the question is asked about questionstring Yes The natural-language question to ask about the entity timePeriodstring Yes Time period of conversations to consider: LAST_7DAYS, LAST_30DAYS, LAST_90DAYS, LAST_90_DAYS_SINCE_LAST_ACTIVITY, LAST_YEAR_SINCE_LAST_ACTIVITY, LAST_YEAR, THIS_WEEK, THIS_MONTH, THIS_YEAR, THIS_QUARTER, CUSTOM_RANGE, or ALL_CONVERSATIONS fromDateTimestring No Start date/time (UTC, ISO-8601) for calls and emails to include. Required when timePeriod is CUSTOM_RANGE. toDateTimestring No End date/time (UTC, ISO-8601) for calls and emails to include. Required when timePeriod is CUSTOM_RANGE.
Parameter Type Description requestIdstring A Gong request reference ID for troubleshooting purposes numOfCallsSearchednumber Number of calls used to generate the answer numOfEmailsSearchednumber Number of emails used to generate the answer answerarray Sections of the generated answer with supporting evidence ↳ answerItems array Text items that make up this part of the answer ↳ callFindings array Evidence from calls used to generate this answer item ↳ emailFindings array Evidence from emails used to generate this answer item
Generate an AI brief (configured in Gong Agent Studio) for a CRM account, deal, contact, or lead. Consumes Gong credits.
Inputs and outputsParameter Type Required Description accessKeystring Yes Gong API Access Key accessKeySecretstring Yes Gong API Access Key Secret workspaceIdstring Yes Gong workspace ID the entity belongs to briefNamestring Yes Name of the brief to generate, as configured in Gong Agent Studio > AI Briefer crmEntityTypestring Yes Type of the CRM entity: ACCOUNT, CONTACT, DEAL, or LEAD crmEntityIdstring Yes The CRM ID of the entity to generate the brief for timePeriodstring Yes Time period of conversations to consider: LAST_7DAYS, LAST_30DAYS, LAST_90DAYS, LAST_90_DAYS_SINCE_LAST_ACTIVITY, LAST_YEAR_SINCE_LAST_ACTIVITY, LAST_YEAR, THIS_WEEK, THIS_MONTH, THIS_YEAR, THIS_QUARTER, CUSTOM_RANGE, or ALL_CONVERSATIONS fromDateTimestring No Start date/time (UTC, ISO-8601) for calls and emails to include. Required when timePeriod is CUSTOM_RANGE. toDateTimestring No End date/time (UTC, ISO-8601) for calls and emails to include. Required when timePeriod is CUSTOM_RANGE.
Parameter Type Description requestIdstring A Gong request reference ID for troubleshooting purposes numOfCallsSearchednumber Number of calls used to generate the brief numOfEmailsSearchednumber Number of emails used to generate the brief briefSectionsarray Sections of the generated brief ↳ title string Section title ↳ sectionSummary array The content displayed for this section ↳ briefSectionType string The section type, which determines the source of the data ↳ conversationFindings object Evidence from calls and emails used to generate this section ↳ webFindings array Evidence from web search results used to generate this section ↳ mcpResult object Result from an MCP data source used to generate this section
Retrieve Gong log entries of a specific type within a time range.
Inputs and outputsParameter Type Required Description accessKeystring Yes Gong API Access Key accessKeySecretstring Yes Gong API Access Key Secret logTypestring Yes Type of logs requested: AccessLog, UserActivityLog, UserCallPlay, ExternallySharedCallAccess, or ExternallySharedCallPlay fromDateTimestring Yes Time from which to retrieve log records, in ISO-8601 format (e.g., '2024-01-01T00:00:00Z') toDateTimestring No Time until which to retrieve log records, in ISO-8601 format. Defaults to the latest available logs when omitted. cursorstring No Pagination cursor from a previous response
Parameter Type Description requestIdstring A Gong request reference ID for troubleshooting purposes logEntriesarray Log entries matching the requested type and time range ↳ userId string Gong's unique numeric identifier for the user, if available ↳ userEmailAddress string Email address of the user, if available ↳ userFullName string Full name of the user, if available ↳ impersonatorUserId string Gong's unique numeric identifier for the impersonating user, if any ↳ impersonatorEmailAddress string Email address of the impersonating user, if any ↳ impersonatorFullName string Full name of the impersonating user, if any ↳ impersonatorCompanyId string Gong's unique numeric identifier for the impersonating user's company ↳ eventTime string Time of the event in ISO-8601 format ↳ logRecord object Log fields and associated values, populated dynamically per log type cursorstring Pagination cursor for the next page totalRecordsnumber Total number of records matching the filter currentPageSizenumber Number of records in the current page currentPageNumbernumber Current page number
Find all references to an email address in Gong (calls, email messages, meetings, CRM data, engagement).
Inputs and outputsParameter Type Required Description accessKeystring Yes Gong API Access Key accessKeySecretstring Yes Gong API Access Key Secret emailAddressstring Yes Email address to look up
Parameter Type Description requestIdstring Gong request reference ID for troubleshooting callsarray Related calls referencing this email address ↳ id string Gong's unique numeric identifier for the call (up to 20 digits) ↳ status string Call status ↳ externalSystems array Links to external systems such as CRM, Telephony System, etc. ↳ system string External system name ↳ objects array List of objects within the external system ↳ objectType string Object type ↳ externalId string External ID emailsarray Related email messages referencing this email address ↳ id string Gong's unique 32 character identifier for the email message ↳ from string The sender's email address ↳ sentTime string Date and time the email was sent in ISO-8601 format ↳ mailbox string The mailbox from which the email was retrieved ↳ messageHash string Hash code of the email message meetingsarray Related meetings referencing this email address ↳ id string Gong's unique identifier for the meeting customerDataarray Links to data from external systems (CRM, Telephony, etc.) that reference this email ↳ system string External system name ↳ objects array List of objects in the external system ↳ id string Gong's unique numeric identifier for the Lead or Contact (up to 20 digits) ↳ objectType string Object type ↳ externalId string External ID ↳ mirrorId string CRM Mirror ID ↳ fields array Object fields ↳ name string Field name ↳ value json Field value customerEngagementarray Customer engagement events (such as viewing external shared calls) ↳ eventType string Event type ↳ eventName string Event name ↳ timestamp string Date and time the event occurred in ISO-8601 format ↳ contentId string Event content ID ↳ contentUrl string Event content URL ↳ reportingSystem string Event reporting system ↳ sourceEventId string Source event ID
Find all references to a phone number in Gong (calls, email messages, meetings, CRM data, and associated contacts).
Inputs and outputsParameter Type Required Description accessKeystring Yes Gong API Access Key accessKeySecretstring Yes Gong API Access Key Secret phoneNumberstring Yes Phone number to look up (must start with + followed by country code)
Parameter Type Description requestIdstring Gong request reference ID for troubleshooting suppliedPhoneNumberstring The phone number that was supplied in the request matchingPhoneNumbersarray Phone numbers found in the system that match the supplied number emailAddressesarray Email addresses associated with the phone number callsarray Related calls referencing this phone number ↳ id string Gong's unique numeric identifier for the call (up to 20 digits) ↳ status string Call status ↳ externalSystems array Links to external systems such as CRM, Telephony System, etc. ↳ system string External system name ↳ objects array List of objects within the external system ↳ objectType string Object type ↳ externalId string External ID emailsarray Related email messages associated with contacts matching this phone number ↳ id string Gong's unique 32 character identifier for the email message ↳ from string The sender's email address ↳ sentTime string Date and time the email was sent in ISO-8601 format ↳ mailbox string The mailbox from which the email was retrieved ↳ messageHash string Hash code of the email message meetingsarray Related meetings associated with this phone number ↳ id string Gong's unique identifier for the meeting customerDataarray Links to data from external systems (CRM, Telephony, etc.) that reference this phone number ↳ system string External system name ↳ objects array List of objects in the external system ↳ id string Gong's unique numeric identifier for the Lead or Contact (up to 20 digits) ↳ objectType string Object type ↳ externalId string External ID ↳ mirrorId string CRM Mirror ID ↳ fields array Object fields ↳ name string Field name ↳ value json Field value
Erase all Gong data (calls, email messages, leads, contacts) referencing an email address. Asynchronous and irreversible.
Inputs and outputsParameter Type Required Description accessKeystring Yes Gong API Access Key accessKeySecretstring Yes Gong API Access Key Secret emailAddressstring Yes Email address whose associated data should be permanently erased from Gong
Parameter Type Description requestIdstring A Gong request reference ID for troubleshooting purposes
Erase all Gong data (calls, leads, contacts) referencing a phone number. Asynchronous and irreversible.
Inputs and outputsParameter Type Required Description accessKeystring Yes Gong API Access Key accessKeySecretstring Yes Gong API Access Key Secret phoneNumberstring Yes Phone number whose associated data should be permanently erased from Gong. Must include a leading "+" and country code (e.g., +14255552671)
Parameter Type Description requestIdstring A Gong request reference ID for troubleshooting purposes
A trigger starts a workflow when a supported event occurs in this service.
Trigger workflow when a call is completed and processed in Gong
Configuration and outputsParameter Type Required Description gongJwtPublicKeyPemstring No Required only when your Gong rule uses Signed JWT header . Sim verifies RS256, webhook_url, and body_sha256 per Gong. If empty, only the webhook URL path authenticates the request.
Parameter Type Description eventTypestring Constant identifier for automation-rule webhooks (gong.automation_rule). Gong does not send distinct event names in the payload. callIdstring Gong call ID (same value as metaData.id when present) isTestboolean Whether this is a test webhook from the Gong UI callDatajson Full call data object metaDataobject ↳ id string Gong call ID ↳ url string URL to the call in Gong ↳ title string Call title ↳ scheduled string Scheduled start time (ISO 8601) ↳ started string Actual start time (ISO 8601) ↳ duration number Call duration in seconds ↳ primaryUserId string Primary Gong user ID ↳ workspaceId string Gong workspace ID ↳ direction string Call direction (Inbound, Outbound, etc.) ↳ system string Communication platform used (e.g. Zoom, Teams) ↳ scope string Call scope (Internal, External, or Unknown) ↳ media string Media type (Video or Audio) ↳ language string Language code (ISO-639-2B) ↳ sdrDisposition string SDR disposition classification (when present) ↳ clientUniqueId string Call identifier from the origin recording system (when present) ↳ customData string Custom metadata from call creation (when present) ↳ purpose string Call purpose (when present) ↳ meetingUrl string Web conference provider URL (when present) ↳ isPrivate boolean Whether the call is private (when present) ↳ calendarEventId string Calendar event identifier (when present) partiesarray Array of call participants with name, email, title, and affiliation contextarray Array of CRM context objects (Salesforce opportunities, accounts, etc.) trackersarray Keyword and smart trackers from call content (same shape as Gong extensive-calls content.trackers) topicsarray Topic segments with durations from call content (content.topics) highlightsarray AI-generated highlights from call content (content.highlights)
Generic webhook trigger for all Gong events
Configuration and outputsParameter Type Required Description gongJwtPublicKeyPemstring No Required only when your Gong rule uses Signed JWT header . Sim verifies RS256, webhook_url, and body_sha256 per Gong. If empty, only the webhook URL path authenticates the request.
Parameter Type Description eventTypestring Constant identifier for automation-rule webhooks (gong.automation_rule). Gong does not send distinct event names in the payload. callIdstring Gong call ID (same value as metaData.id when present) isTestboolean Whether this is a test webhook from the Gong UI callDatajson Full call data object metaDataobject ↳ id string Gong call ID ↳ url string URL to the call in Gong ↳ title string Call title ↳ scheduled string Scheduled start time (ISO 8601) ↳ started string Actual start time (ISO 8601) ↳ duration number Call duration in seconds ↳ primaryUserId string Primary Gong user ID ↳ workspaceId string Gong workspace ID ↳ direction string Call direction (Inbound, Outbound, etc.) ↳ system string Communication platform used (e.g. Zoom, Teams) ↳ scope string Call scope (Internal, External, or Unknown) ↳ media string Media type (Video or Audio) ↳ language string Language code (ISO-639-2B) ↳ sdrDisposition string SDR disposition classification (when present) ↳ clientUniqueId string Call identifier from the origin recording system (when present) ↳ customData string Custom metadata from call creation (when present) ↳ purpose string Call purpose (when present) ↳ meetingUrl string Web conference provider URL (when present) ↳ isPrivate boolean Whether the call is private (when present) ↳ calendarEventId string Calendar event identifier (when present) partiesarray Array of call participants with name, email, title, and affiliation contextarray Array of CRM context objects (Salesforce opportunities, accounts, etc.) trackersarray Keyword and smart trackers from call content (same shape as Gong extensive-calls content.trackers) topicsarray Topic segments with durations from call content (content.topics) highlightsarray AI-generated highlights from call content (content.highlights)