Gong
API integration

list_all_gong_users

List all of the company's users. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:users:read'.

get_single_gong_user_by_id

Retrieve a specific user. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:users:read'.

list_all_gong_workspaces

List all company workspaces including their details.

list_all_gong_calls

List calls that took place during a specified date range. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:calls:read:basic'.

get_single_gong_call_by_id

Retrieve data for a specific call. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:calls:read:basic'.

create_a_gong_call

When using this endpoint, either provide a downloadMediaUrl or use the returned callId in a follow-up request to /v2/calls/{id}/media to upload the media file. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:calls:create'.

create_a_gong_activity_aggregate_by_period

Retrieve aggregated activity statistics for Gong team members grouped by a specified time period. Returns one record per user per period with counts of calls, listens, comments, and other tracked actions. Requires from_date, to_date, and aggregation_period.

create_a_gong_activity_aggregate

Lists the activity of multiple users within the Gong system during a defined period. Given the period, this endpoint returns multiple records, one for each user, with an applicable activity during the period. Each record includes statistics about the user's activity. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:stats:user-actions'.

create_a_gong_activity_scorecard

Retrieve all the answers for the scorecards that were reviewed during a specified date range, for calls that took place during a specified date range, for specific scorecards or for specific reviewed users. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:stats:scorecards'.

list_all_gong_all_permission_profiles

Returns a list of all permission profiles. The listing is in the alphabetical order of the profile names.

create_a_gong_assign_cool_off_override

Use this endpoint to assign a number of prospects to a flow regardless of the cool off status. 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 100 prospects to a flow in a single request. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:flows:write'.

list_all_gong_call_outcomes

List available call outcomes defined in Gong, used to categorize the result of a call (e.g., "Connected", "No Answer").

create_a_gong_calls_extensive

Lists detailed call data for calls that took place during a specified date range, have specified call IDs, or were hosted by specified users. Requires scope 'api:calls:read:extensive'. Clients requesting media download URLs should also have scope 'api:calls:read:media-url'.

create_a_gong_calls_transcript

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'.

delete_a_gong_calls_users_accese_by_id

Remove individual user access from calls in Gong. Only revokes access previously granted via the API; access granted through other means (e.g., sharing) remains unchanged. Returns a success response. Requires a request body specifying the call ids and user ids to revoke.

create_a_gong_calls_users_accese

Returns a list of users who have received individual access to calls through the API. Does not cover users who have access for other reasons (e.g., sharing recipients or permission profiles). Requires scope 'api:call-user-access:read'.

update_a_gong_calls_users_accese_by_id

Give individual users access to calls. If a user already has access (perhaps the call was shared with them, or they have access through their permission profiles) the request will have no effect. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:call-user-access:write'.

list_all_gong_coachings

List all of the coaching metrics of a manager. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:coaching:read'.

update_a_gong_content_shared_by_id

Report a content-share engagement event in Gong, recording when a user shares content (e.g., a contract) with external participants. The event appears in Gong's activity timeline. Returns a registration response on success. Requires a ContentSharedEvent request body.

update_a_gong_content_viewed_by_id

Report a content-viewed engagement event in Gong, recording when an external participant (e.g., a prospect) views a piece of content such as a contract. The event appears in Gong's activity timeline. Returns a registration response on success.

list_all_gong_crm_entities

List Gong CRM entities by id for development-phase verification that uploaded objects were processed correctly. Returns a JSON object keyed by CRM id with entity field values, or null when an id is not found. Required: integrationId, objectType, objectsCrmIds. Max 100 objects per request.

create_a_gong_crm_entity

Insert, update, or delete a CRM entity (ACCOUNT, CONTACT, DEAL, LEAD, BUSINESS_USER, or STAGE) in Gong by uploading an LDJSON file. Processing is asynchronous; a 201 response confirms upload and returns a request id pollable via the request-status endpoint. Required: integration_id, object_type, client_request_id, and data_file.

list_all_gong_crm_entity_schemas

List CRM entity schema fields in Gong for a given object type. Returns field definitions including name, label, type, and isDeleted. Required: integration_id, object_type (ACCOUNT, CONTACT, DEAL, or LEAD; case-sensitive).

create_a_gong_crm_entity_schema

Upload or update the field schema for a Gong CRM entity type (Account, Contact, Deal, or Lead). Returns a schema update response on success. Required: integration_id, object_type, and a JSON array of field definitions in the request body. All existing fields must be included in each update; omitting a field causes an error.

update_a_gong_crm_integration_by_id

Creates your CRM integration with Gong. Returns an integrationId, which should be used in requests to the CRM API to enable correct association of CRM data. Multiple CRM integrations are not supported. To create a new integration, delete the old one first (DELETE /v2/crm/integrations). When accessed using a bearer token, this endpoint requires the 'api:crm:integration:register' scope.

list_all_gong_crm_integrations

Retrieve the Generic CRM integration details configured via PUT /v2/crm/integrations. Only one integration can exist at a time.

delete_a_gong_crm_integration_by_id

Asynchronously deletes a CRM integration and all its associated CRM objects (Accounts, Contacts, Deals, Leads, and Users). Use the clientRequestId to check the status of the delete request via the /request-status endpoint. A status of DONE indicates successful deletion (may take up to 24 hours). When accessed using a bearer token, this endpoint requires the 'api:crm:integration:delete' scope.

list_all_gong_crm_request_status

Get the status of an asynchronous Gong CRM request (entity upload or integration deletion). Returns the current status (PENDING, IN_PROGRESS, DONE, or FAILED) and any processing errors. Required: integration_id, client_request_id.

update_a_gong_customer_engagement_action_by_id

Push a custom engagement action event into Gong to display on the activity timeline when external participants engage with content (e.g., a contract is signed). Returns a confirmation response on success. Duplicate events return a 409 conflict.

list_all_gong_data_privacy_data_for_email_addreses

Shows the elements in the Gong system that reference the given email address. Given an emails address, this endpoint returns details of all calls and email messages that reference this address, and any leads or contacts with this email address. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:data-privacy:read'.

list_all_gong_data_privacy_data_for_phone_numbers

Shows the elements in the Gong system that reference the given phone number. Given a phone number, this endpoint returns details of any leads or contacts with this phone number and their associated calls and email messages. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:data-privacy:read'.

create_a_gong_data_privacy_erase_data_for_email_addrese

Delete all Gong data associated with a given email address, including calls, email messages, leads, and contacts that reference it. Deletion is asynchronous and may take several hours. Required: emailAddress.

create_a_gong_data_privacy_erase_data_for_phone_number

Delete all Gong leads, contacts, associated emails, and calls matching a given phone number. Deletion is asynchronous and may take several hours. Required: phoneNumber (must start with + followed by country code).

create_a_gong_digital_interaction

When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:digital-interactions:write'.

list_all_gong_entities_ask_entities

Returns the answer to a question about a specified entity. The answer is generated from calls or emails associated with the entity within the specified time period. A maximum of 60 calls and 500 emails are used to answer the question. A call to this API consumes Gong credits according to the number of emails and calls used to generate the answer. Supported entities are Accounts, Deals, Contacts, or Leads that exist in your CRM. The response includes: The answer Details of emails and calls used to generate the answer Required authorization scope: 'api:ai-ask:read'. Get AI-generated answers to natural language questions about entities (Accounts, Deals, Contacts, Leads).

list_all_gong_entities_get_briefs

Get a brief for an account, deal, contact, or lead that exists in your CRM. Briefs are set up in the Gong Agent Studio and you must provide the name of the brief you want to generate. A call to this API consumes Gong credits according to the number of emails and calls used to generate the brief. The brief is generated from calls or emails associated with the entity within the specified time period. The response includes: The brief Details of emails and calls used to generate the brief Required authorization scope: 'api:ai-briefer:read'. Get AI-generated briefs for entities (Accounts, Deals, Contacts, Leads) using briefs configured in Gong.

list_all_gong_flows

List Gong Engage flows including company, personal, and shared flows for a given user. Returns flow objects with id, name, and visibility type. Required: flowOwnerEmail.

list_all_gong_flows_folders

Engage flow folders 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 flow folders which are only available to them. Shared: reps can share a flow folder with other reps. Those reps can then add flows to the flow folder. This endpoint returns all company flow folders, together with personal flow folders and flow folders shared with the user specified in the flowEmailOwner parameter. When accessed through a Bearer token authorization method, use the 'api:flows:read' scope.

create_a_gong_flows_prospect

Get the Gong Engage flows assigned to the given crmProspectsIds. When querying by crmProspectsIds, only open (Pending/Running/Paused) flows are returned. Alternatively this endpoint can be used to get the flows assigned to prospects by the given flowInstanceIds. When querying by flowInstanceIds, all flows including finished ones are returned. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:flows:read'.

create_a_gong_integration_setting

When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:integration-settings:write'.

create_a_gong_integration_status

When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:meetings:integration:status'.

list_all_gong_library_folder_contents

Given a folder id, this endpoint retrieves a list of calls in it. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:library:read'.

list_all_gong_library_folders

Use this endpoint to retrieve a list of public library folders. We do not allow retrieval of either private or archived folders. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:library:read'.

list_all_gong_logs

List log entries that took place during a specified time range. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:logs:read'.

update_a_gong_media_by_id

Adds a call media, recorded by a telephony system (PBX) or other media recording facility. Gong accepts call recordings in various audio and video file formats, including WAV, MP3, MP4, MKV and FLAC. If uploading a dual-channel (stereo) file separated by speaker, make sure to specify which channel correspondsto 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'.

delete_a_gong_meeting_by_id

When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:meetings:user:delete'.

update_a_gong_meeting_by_id

When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:meetings:user:update'.

create_a_gong_meeting

When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:meetings:user:create'.

list_all_gong_permission_profile_users

Returns a list of all users whose access is controlled by the given permission profile. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:users:read'.

create_a_gong_prospects_assign

Use this endpoint to assign a number of prospects to a flow. Prospects can be contacts or leads in your CRM. Generate a list of comma separated CRM Ids of the prospects you want to add to a flow. The flowInstanceOwnerEmail parameter is the email address of the Gong user who set up the flow instance and owns the flow to-dos. You can assign up to 100 prospects to a flow in a single request. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:flows:write'.

create_a_gong_prospects_bulk_assignment

Use this endpoint to asynchronously submit a bulk assignment of prospects to a flow. Prospects can be contacts or leads in your CRM. You can assign up to 50 prospects to a flow in a single request. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:flows:write'.

get_single_gong_prospects_bulk_assignment_by_id

Use this endpoint to get the results of a bulk assignment of prospects to a flow. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:flows:read'.

create_a_gong_prospects_unassign_flows_by_crm_id

This endpoint lets you remove a specific prospect from the flows they are assigned to. To remove the prospect from all flows they are assigned to, send the crmProspectId only. If you want to remove the prospect from a specific flow, get the flow id from the /v2/flows/prospects endpoint and include the crmProspectId and flowId in the request. The Ids of the flows the prospect was successfully removed from are returned in the response. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:flows:write'.

create_a_gong_prospects_unassign_flows_by_instance_id

Unassign prospects from Gong flows by flow instance id. Returns the flow instance ids from which prospects were successfully removed. Requires a list of flow instance ids (up to 200 per request).

get_single_gong_settings_history_by_id

Retrieve a specific user's settings history. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:users:read'.

list_all_gong_settings_scorecards

Retrieve all scorecards within the Gong system.

list_all_gong_settings_trackers

Retrieves details of all keyword trackers in the system or in a given workspace. When accessed through a Bearer token authorization method, this endpoint requires the 'api:settings:trackers:read' scope.

create_a_gong_stats_interaction

Returns interaction stats for users based on calls that have Whisper turned on. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:stats:interaction'.

create_a_gong_task

Retrieves a list of Engage tasks assigned to a specific user. Supports filters for task type, action, and status. Results include detailed metadata such as ownership, creation/due dates, associated contacts, flows, accounts, and opportunities. Requires scope 'api:tasks:read'.

update_a_gong_task_by_id

Use this endpoint to update the status or due date of an existing Engage task. The task status can be changed to OPEN, DONE, or DISMISSED. This is useful for managing task workflows such as marking tasks complete or rescheduling them based on user actions or system events. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:tasks:write'.

create_a_gong_users_extensive

List multiple Users. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:users:read'.