Instant Connections

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

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

Lists the aggregated activity of multiple users within the Gong system for each time period within the defined date range. This endpoint returns multiple records, one for each user. For each user there are items for every time period in the date range, including statistics about the user's activity. Records are returned only for users with activity in the range. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:stats:user-actions'.

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

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

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

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

Create a permission profile in a given workspace.

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

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

Deletes a Gong meeting created via the Meetings API (Beta). Use this to remove a scheduled meeting by providing its unique meeting ID and the organizer's email address. Note: This endpoint is for meetings created through Gong's Meetings API, not for recorded calls accessible via the Calls API. Returns organizer email and request ID upon successful deletion.

Remove individual user access from calls. The request can only remove access previously given by the /v2/calls/users-access API. If a given user does not have access to the call, they will be unaffected. If a given user does have access to the call, but not through the public API (for example if the call was shared with the user), the user's access will remain unchanged. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:call-user-access:write'.

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

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

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

Tool to fetch specific call metadata by call ID. Use when you need to retrieve detailed information about a specific call using Gong's unique identifier.

Tool to retrieve call transcripts from Gong. Use when you need to access the text content of calls with speaker information, timestamps, and topic categorization. Requires either a date range or specific call IDs to filter results.

Retrieves details of generic CRM integrations registered with Gong. This endpoint returns generic CRM integrations that were set up using the PUT /v2/crm/integrations endpoint. It does NOT return native integrations (e.g., SALESFORCE, HubSpot) that are configured through Gong's UI. Note: Gong allows only one active CRM integration at a time (either generic or native). If a native integration is active, you cannot register a generic integration until the native one is disconnected. Returns an empty list if no generic CRM integrations exist. Required OAuth scope: 'api:crm:integrations:read'

Retrieves specific CRM objects by their IDs from Gong's CRM integration. Use this endpoint to fetch detailed information about CRM entities (accounts, contacts, deals, or leads) that have been uploaded to Gong through a registered CRM integration. This is particularly useful during development to verify that CRM objects are uploaded and processed correctly. Prerequisites: - A registered CRM integration (use the register CRM integration endpoint first) - CRM objects must be uploaded to Gong before they can be retrieved - You need the specific CRM IDs of the objects you want to fetch The response includes a crmObjectsMap containing the requested CRM objects with their fields and values as defined in your CRM system.

Tool to retrieve Gong Engage flows assigned to specified prospects. Use when you need to get flow instance IDs and details for specific CRM prospect IDs. Requires 'api:flows:read' scope.

Tool to retrieve interaction trend statistics for users based on calls with Whisper enabled. Use when analyzing user interaction patterns, measuring engagement metrics, or tracking communication behaviors over a specified date range. Returns metrics like interactivity, question rate, longest monologue, and patience levels.

Returns a permission profile.

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

Tool to retrieve individual user details by user ID. Use when you need to fetch specific user information including profile data, settings, and organizational details.

Tool to retrieve historical changes to a user's settings. Use when you need to track capability modifications for a specific user identified by their Gong ID.

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

Returns a list of all workspaces including their details. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:workspaces:read'.

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

Tool to retrieve all available call outcomes defined in Gong. Use when you need to list all call outcome configurations including their categories, sentiments, and automation settings.

Tool to list all Gong Engage flow folders with visibility types. Use when you need to retrieve company flow folders, personal folders, and folders shared with a specific user.

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

Engage flows have the following visibility types: * Company: visible to everyone in the company, can only be edited by users with edit permissions. * Personal: reps can set up their own flows which are only available to them. * Shared: reps can share a flow with other reps. Those reps can then add leads to the flow. This endpoint returns all company flows, together with personal flows and flows shared with the user specified in the flowOwnerEmail parameter. When accessed through a Bearer token authorization method, use the 'api:flows:read' scope.

Retrieves schema fields for a specific CRM object type within a Generic CRM integration. Returns field metadata including names, data types (STRING, NUMBER, PICKLIST, etc.), labels, reference relationships, and picklist values for ACCOUNT, CONTACT, DEAL, or LEAD objects. IMPORTANT: Only works with Generic CRM integrations created via /v2/crm/integrations API. Does NOT work with native integrations (Salesforce, HubSpot, Dynamics 365). Required: integrationId (from Generic CRM integration creation), objectType (ACCOUNT/CONTACT/DEAL/LEAD).

Tool to retrieve all scorecards within the Gong system. Use when you need to list all scorecard configurations and their associated assessment questions.

Tool to retrieve Engage tasks assigned to a specific user with filtering options. Use when you need to list tasks by status, action type, and other criteria. Requires 'api:tasks:read' scope.

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

Retrieves a list of users who have been granted individual access to specific calls through the API. This endpoint returns only users with explicit API-granted access and doesn't include users who have access through other means (such as being sharing recipients or having access through permission profiles). When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:call-user-access:read'.

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

Retrieve the daily activity of multiple users within the Gong system for a range of dates. This endpoint returns records including statistics about each user's activity, on the daily level. Records are returned only for users with activity in the range. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:stats:user-actions:detailed'.

Updates an existing CRM integration in the Gong platform. This endpoint allows you to modify the details of a previously set up integration between Gong and your Customer Relationship Management (CRM) system. It's primarily used for changing the integration's name or reassigning the ownership to a different team member. This operation is crucial for maintaining accurate and up-to-date integration configurations, especially when there are changes in your organization's structure or integration strategies. Note that this endpoint only updates the integration metadata and does not affect the actual data synchronization between Gong and your CRM.

Tool to push content share engagement events to Gong's activity timeline. Use when documenting that a Gong user shared content with external participants such as contracts or proposals.

Tool to log content view engagement events to Gong's activity timeline. Use when tracking external participants viewing shared content like documents or presentations.

Report custom engagement events to Gong's activity timeline. Use this action to track when external participants (prospects, customers) engage with content such as viewing documents, signing contracts, attending webinars, or downloading materials. The events appear in Gong's activity timeline and help track customer engagement. Required fields: reportingSystem (identifier for your system), eventTimestamp (ISO-8601 format), and actor information (at minimum actor__email and actor__name) to identify who performed the action. Common use cases: Document viewed, contract signed, webinar attended, presentation downloaded, proposal opened. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:engagement-data:write'.

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

Retrieves data privacy information for a third-party email address. Shows all elements in the Gong system that reference the given email address, including calls, email messages, meetings, customer data, and engagement events. This endpoint is designed for third-party privacy requests (e.g., customers, prospects, or external contacts) and will reject internal Gong user email addresses. When accessed through a Bearer token authorization, this endpoint requires the scope 'api:data-privacy:read'.

Lists detailed call data for calls that took place during a specified date range, have specified call IDs or hosted by specified users. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:calls:read:extensive'. Moreover, clients requesting media download URLs by the contentSelector.exposedFields.media field should also have the scope 'api:calls:read:media-url'.

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

Returns a list of all calls that were manually associated or re-associated with CRM account and deal/opportunity since a given time. Actions will be listed in the ascending order of their timing. Notice if a call was associated and later re-associated the API will return both events. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:crm-calls:manual-association:read'.

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.

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

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

Tool to unassign flows from prospects by their CRM Prospect ID. Use when you need to remove a prospect from specific flows or all flows in Gong Engage.

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

Update a permission profile.

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

Validates Gong meeting integration status for one or more users by their email addresses. This endpoint checks if users have their meeting integration properly configured in Gong. Returns status information including whether users exist, if their integration is valid, and any error messages with help/fix URLs if issues are found. Use this when you need to: - Verify meeting integration is working for specific users - Diagnose meeting recording or import issues - Check if users are properly set up to use Gong meeting features - Troubleshoot why meetings aren't being captured for certain users Note: The API returns an empty array when all specified users have valid integration or when users don't have meeting integration issues to report.

Add one or more gifts (donations) to an existing gift batch in Blackbaud Raiser's Edge NXT. Use this tool when you need to: - Append new gifts to an open batch for later processing - Batch multiple donations together before committing them - Add gifts with detailed information (payments, splits, custom fields) Prerequisites: - The batch must already exist (use a create batch action first if needed) - The batch must be in "open" status (not committed) - You need the batch_id (system record ID) and constituent_id (donor ID) for each gift Note: This action returns response details for all HTTP status codes (including errors). Check the status_code field in the response to determine success (200) vs errors (4xx/5xx).

Retrieves comprehensive gift details from Blackbaud Raiser's Edge NXT by gift ID. Use this tool when you need to fetch detailed information about a specific gift including: - Gift amount and currency - Donor/constituent information - Gift type and status - Important dates (gift date, post date) - Associated metadata and custom fields The gift_id is the unique system record ID (integer) that identifies the gift in Raiser's Edge NXT.

Retrieves comprehensive membership details from Blackbaud Raiser's Edge NXT by member junction ID. Fetches detailed information about a specific membership including program name, category/subcategory, membership status and standing (Active, Lapsed), start/expiration dates, dues information, and associated constituent ID. Requires a valid member_junction_id (GUID) that uniquely identifies a membership junction record linking a constituent to a membership program in Raiser's Edge NXT. Returns error information in the response object for graceful error handling in agent workflows.

Retrieves payment transaction details from Blackbaud SKY Payments API. Use this to check transaction status, amounts, payment methods, and error details. Transaction IDs come from payment processing endpoints, checkout callbacks, batch operations, or webhook notifications. Requires: Payments API subscription key (Bb-Api-Subscription-Key) and OAuth Bearer token. This retrieves existing transactions; it does not process new payments.

Tool to interact with Blackbaud OneRoster OAuth2 base endpoints. Use to fetch OpenID configuration (/.well-known/openid-configuration), JWKS key set (publickeys), or obtain an access token via the client credentials grant. Ensure client credentials are configured before using the token operation.

Tool to get brand details by brand ID. Use after obtaining the brand identifier.

Tool to list all brands in the account. Use after confirming account is authenticated.

Tool to create a brand-scoped custom field. Use when you need to define and register a new custom field for a specific brand.

Tool to edit an existing custom field. Use when you need to update a custom field's properties after creation.

Tool to list documents sent on behalf of users. Use when fetching and filtering documents you've sent or on behalf of others.

Tool to edit a draft or sent document. Use when updating files, recipients, or document settings before finalizing the document.

Tool to extend a document's expiry date. Use before signing to prolong a document's deadline.

Tool to list documents in My Documents with filters. Use when you need to fetch and filter documents based on various criteria.

Tool to remove authentication from a document. Use when you need to disable signer authentication on an existing document before the signing process.

Tool to send a document for eSignature. Use when you need to deliver documents to recipients for signing.

Tool to list team documents. Use when a team or account admin needs to retrieve all team documents with optional filters.

Tool to create an embedded request link. Use after specifying title and signers to generate an embeddable URL for in-app document preparation and sending.

Helper action to upload a file to R2 temp via the Xava file pipeline, returning a key that can be passed to FileUploadable fields in other actions (e.g., BrandLogo in brand create).

Tool to get remaining BoldSign API credits count. Use after authenticating your BoldSign account.

Tool to attach a file from a provided URL to a task. The file will be downloaded and attached asynchronously. Use when you need to add a file attachment to a task from a URL source.

Tool to create a new comment on a DART task. Use when you need to add feedback, notes, or discussion to a specific task. Supports markdown formatting and threaded replies via parentId.

Tool to add a time tracking entry to a DART task. Use when you need to record time spent on a specific task. The finishedAt timestamp must be after startedAt.

Tool to create a new doc in Dart. Use when you need to record a new document that the user intends to write down. By default, the created doc will be in the Docs folder unless a specific folder is specified.

Tool to create a new task in DART with title and optional metadata. Use when you need to add a task to a workspace.

Tool to move an existing doc to the trash where it can be recovered if needed. Use when you need to delete a doc without permanently removing it.

Tool to delete an existing task in Dart by moving it to trash. Use when a task needs to be removed but can be recovered later.

Tool to retrieve workspace configuration including dartboards, folders, types, statuses, and more. Use when you need to understand available options in the workspace.

Tool to retrieve an existing doc with metadata and content. Use when you need to access a specific document's details including title, folder, and text content.

Tool to retrieve an existing task with full details including title, dartboard, status, and description. Use when you need to fetch complete information about a specific task.

Tool to list comments for a task with filtering options. Use when you need to retrieve comments on a specific task. Supports filtering by author, text content, date range, and pagination. Can be ordered by date or hierarchical thread structure.

Tool to list docs with filtering and search capabilities. Use when you need to retrieve documents from DART with filters like folder, title, text content, or full-text search. Supports pagination and custom ordering by creation date, update date, or title.

Tool to search help center articles by semantic similarity to query. Use when you need to find relevant help articles based on a short search query (1-5 words). Returns up to two most relevant articles.

Tool to list tasks with powerful filtering options. Use when you need to retrieve tasks from DART with filters like dartboard, status, assignee, tags, priority, dates, or completion state. Supports pagination and custom ordering.

Tool to move a task to a specific position within its dartboard. Use when you need to reorder tasks in a list. Specify either afterTaskId or beforeTaskId to position the task.

Tool to retrieve a skill by its exact title from the workspace. Use when you need to find details about a specific skill including its ID and instructions.

Tool to update an existing doc in Dart. Use when you need to modify a document's title, folder location, or content. Any properties not specified will remain unchanged.

Tool to update an existing task in DART with new properties. Use when you need to modify a task's title, status, assignees, or other attributes. Only properties specified in the request will be updated.