Skip to main content
Gong logo

Overview

Add Gong to any ModuleX agent or workflow. Revenue intelligence platform for recording, transcribing, and analyzing sales conversations via the Gong REST API (your per-tenant https://<region>-<id>.api.gong.io/v2 base URL).
Categories: Sales · Revenue Intelligence · Conversation Analytics · Auth: Gong API Key · Actions: 5

Authentication

Gong API Key

Authenticate with a Gong Access Key + Access Key Secret (Company Settings -> API), sent as HTTP Basic auth.
1

Step 1

Sign in to Gong as a technical administrator
2

Step 2

Go to Company Settings -> Ecosystem -> API (https://app.gong.io/company/api)
3

Step 3

Click ‘Create’ to generate an Access Key and Access Key Secret (the Secret is shown only once)

Required Credentials

FieldDescriptionRequiredFormat
Access KeyGong API Access KeyYes-
Access Key SecretGong API Access Key Secret (shown only once at creation)Yes-
API Base URLYour Gong API base URL (region/tenant-specific), e.g. https://us-12345.api.gong.ioYeshttps://us-12345.api.gong.io

Available Actions

Parameters

client_unique_id
string
required
A call’s unique identifier in the PBX or recording system. Used to prevent duplicate uploads.
actual_start
string
required
The actual date and time when the call started in ISO-8601 format (e.g., 2018-02-18T02:30:00-07:00 or 2018-02-18T08:00:00Z).
direction
string
required
Whether the call is Inbound, Outbound, Conference, or Unknown.
primary_user
string
required
The Gong internal user ID of the team member who hosted the call.
parties
array
required
A list of the call’s participants as JSON objects. Each party can have: phoneNumber, emailAddress, name, mediaChannelId.
title
string
The title of the call, available for indexing and search.
purpose
string
The purpose of the call. Free text up to 255 characters.
scheduled_start
string
The date and time the call was scheduled to begin in ISO-8601 format.
scheduled_end
string
The date and time the call was scheduled to end in ISO-8601 format.
duration
integer
The actual call duration in seconds.
disposition
string
The disposition of the call. Free text up to 255 characters.
meeting_url
string
The URL of the conference call by which users join the meeting.
call_provider_code
string
Code identifying the conferencing/telephony system: zoom, clearslide, gotomeeting, ringcentral, outreach, insidesales.
download_media_url
string
The URL from which Gong can download the media file. Must be unique, max 1.5GB.
workspace_id
string
Optional workspace identifier for call placement.
language_code
string
Language code for transcription (e.g., en-US, fr-FR). Optional; Gong auto-detects if not set.

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "request_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Request Id"
    },
    "call_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Call Id"
    }
  },
  "required": [
    "success"
  ],
  "title": "AddNewCallOutput",
  "type": "object"
}

Parameters

from_date_time
string
Date and time (ISO-8601) from which to list recorded calls.
to_date_time
string
Date and time (ISO-8601) until which to list recorded calls.
workspace_id
string
The ID of the workspace to filter by.
call_ids
array
List of call ID strings to filter. If not supplied, returns all calls in date range.
primary_user_ids
array
List of user ID strings. If supplied, returns only calls hosted by these users.
max_results
integer
Maximum number of results to return. (Default: 600)
context
string
Context level: None, Basic (add links), or Extended (include link data). (Default: None)
context_timing
array
Timing for context data: ‘Now’ or ‘TimeOfCall’ or both. Only valid when context is Extended.
include_parties
boolean
Whether to include parties in the response. (Default: false)
exposed_fields_content
object
Fields to include for content: structure, topics, trackers, trackerOccurrences, pointsOfInterest, brief, outline, highlights, callOutcome, keyPoints (boolean values).
exposed_fields_interaction
object
Fields to include for interaction: speakers, video, personInteractionStats, questions (boolean values).
include_public_comments
boolean
Whether to include public comments in the response. (Default: false)
include_media
boolean
Whether to include media in the response. (Default: false)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "calls": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Calls",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetExtensiveDataOutput",
  "type": "object"
}

Parameters

from_date_time
string
Date and time (ISO-8601) from which to list recorded calls.
to_date_time
string
Date and time (ISO-8601) until which to list recorded calls.
cursor
string
Pagination cursor returned by a previous call.

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "request_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Request Id"
    },
    "cursor": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Cursor"
    },
    "calls": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Calls",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "ListCallsOutput",
  "type": "object"
}

Response

{
  "$defs": {
    "Workspace": {
      "additionalProperties": false,
      "description": "A Gong workspace entry.",
      "properties": {
        "id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Id"
        },
        "name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "title": "Name"
        }
      },
      "title": "Workspace",
      "type": "object"
    }
  },
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "workspaces": {
      "items": {
        "$ref": "#/$defs/Workspace"
      },
      "title": "Workspaces",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "ListWorkspaceIdOptionsOutput",
  "type": "object"
}

Parameters

from_date_time
string
Date and time (ISO-8601) from which to filter calls.
to_date_time
string
Date and time (ISO-8601) until which to filter calls.
workspace_id
string
The ID of the workspace to filter by.
call_ids
array
List of call ID strings to retrieve transcripts for.

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "call_transcripts": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Call Transcripts",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "RetrieveTranscriptsOfCallsOutput",
  "type": "object"
}

Limits & Quotas

  • Gong API rate limits vary by endpoint and plan tier. Consult your Gong admin for specific limits.
  • The get_extensive_data action paginates internally up to max_results (default 600).
  • Error model: non-2xx responses are caught and returned as success=False + error rather than raising.

Apollo.io

Brandfetch

Clay