> ## Documentation Index
> Fetch the complete documentation index at: https://squad.so/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Gong
> What agents can do in Gong at each access level, and how to connect, limit, and disconnect Gong.
Connect Gong so your agents can work in your Gong account. You choose an access level for each account, and Squad refuses any agent action outside that level.
## Access levels
Each Gong account has an access level: **Read-only** and **Read + write**. Squad refuses any agent action outside that level. You can also narrow or block single agents under **Per-agent access**.
| Level | The connect window describes this level as | Actions agents can use |
| --------------------------- | ------------------------------------------------------ | ---------------------- |
| **Read-only** (recommended) | "Read call recordings, transcripts, users, analytics." | 38 of 58 |
| **Read + write** | "Also create CRM associations and write call data." | 53 of 58 |
**Read-only** is the recommended level. The connect window selects it for you, and you can choose another level.
The Gong sign-in page asks you to approve full access to your account. This is expected. Squad does not narrow the sign-in. It checks every agent action against the level you chose, and it refuses actions outside that level.
## What agents can do at each level
Each level opens with a short summary in plain tasks, then lists every action it adds, grouped by what the action works on. You do not need to name actions. Ask in plain words, and the agent searches for the matching action.
**Find an action.** Open a level and use your browser's find (Ctrl+F, or Cmd+F on a Mac) with a word from the task or part of a slug. Or ask your agent in plain words, for example "What can you do in my Gong account?" The agent can search the Gong actions for you.
Each action shows its name, a one-line description where the Gong action catalog has one, and its slug. The slug is the ID that agents use when they call the action.
Agents can use 38 of the 58 Gong actions at this level:
* View calls
* View users
* View and create reports
* View folders
* View and test integrations
* View profiles
* View transcripts
* View activities
* View associations
* View history
* View logs
* View records
All 38 actions at this level:
| Action | What it does | Slug |
| ------------------------------------ | -------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- |
| Aggregate activity by period via API | Lists the aggregated activity of multiple users within the Gong system for each time period within the defined date range. | `GONG_AGGREGATE_ACTIVITY_BY_PERIOD_VIA_API` |
| Action | What it does | Slug |
| -------------------------------------------- | ------------------------------------------------------------------- | --------------------------------------------------- |
| Retrieve data privacy info for email address | Retrieves data privacy information for a third-party email address. | `GONG_RETRIEVE_DATA_PRIVACY_INFO_FOR_EMAIL_ADDRESS` |
| Action | What it does | Slug |
| ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------- |
| Retrieve manual CRM call associations | Returns a list of all calls that were manually associated or re-associated with CRM account and deal/opportunity since a given time. | `GONG_RETRIEVE_MANUAL_CRM_CALL_ASSOCIATIONS` |
| Action | What it does | Slug |
| ----------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------ |
| Get call by ID | Fetch specific call metadata by call ID. | `GONG_GET_CALL_BY_ID` |
| List call outcomes | Retrieve all available call outcomes defined in Gong. | `GONG_LIST_CALL_OUTCOMES` |
| List folder calls | Given a folder id, this endpoint retrieves a list of calls in it. | `GONG_LIST_FOLDER_CALLS` |
| Manage user call access | Retrieves a list of users who have been granted individual access to specific calls through the API. | `GONG_MANAGE_USER_CALL_ACCESS` |
| Retrieve call data by date range v2 calls | List calls that took place during a specified date range. | `GONG_RETRIEVE_CALL_DATA_BY_DATE_RANGE_V2_CALLS` |
| Retrieve filtered call details | Lists detailed call data for calls that took place during a specified date range, have specified call IDs or hosted by specified users. | `GONG_RETRIEVE_FILTERED_CALL_DETAILS` |
| Action | What it does | Slug |
| ------------------------------------------- | ---------------------------------------------------------------- | -------------------------------------------------- |
| List flow folders | List all Gong Engage flow folders with visibility types. | `GONG_LIST_FLOW_FOLDERS` |
| Retrieve library folders v2 library folders | We do not allow retrieval of either private or archived folders. | `GONG_RETRIEVE_LIBRARY_FOLDERS_V2_LIBRARY_FOLDERS` |
| Action | What it does | Slug |
| ------------------------- | ------------------------------------------------- | -------------------------------- |
| Get user settings history | Retrieve historical changes to a user's settings. | `GONG_GET_USER_SETTINGS_HISTORY` |
| Action | What it does | Slug |
| ---------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------- |
| Get CRM integration details | Retrieves details of generic CRM integrations registered with Gong. | `GONG_GET_CRM_INTEGRATION_DETAILS` |
| Validate meeting integration | Validates Gong meeting integration status for one or more users by their email addresses. | `GONG_VALIDATE_MEETING_INTEGRATION` |
| Action | What it does | Slug |
| ------------------------------------------------- | --------------------------------------------------------------- | -------------------------------------------------------- |
| Retrieve logs data by type and time range v2 logs | List log entries that took place during a specified time range. | `GONG_RETRIEVE_LOGS_DATA_BY_TYPE_AND_TIME_RANGE_V2_LOGS` |
| Action | What it does | Slug |
| ----------------------------- | ------------------------------------------ | ------------------------------------ |
| Fetch all permission profiles | Returns a list of all permission profiles. | `GONG_FETCH_ALL_PERMISSION_PROFILES` |
| Get permission profile | Returns a permission profile. | `GONG_GET_PERMISSION_PROFILE` |
| Action | What it does | Slug |
| ------------------------------- | ------------------------------------------------------------------------ | -------------------------------------- |
| Get CRM objects v2 CRM entities | Retrieves specific CRM objects by their IDs from Gong's CRM integration. | `GONG_GET_CRM_OBJECTS_V2_CRM_ENTITIES` |
| Action | What it does | Slug |
| ------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- |
| Aggregate user activity statistics | Lists the activity of multiple users within the Gong system during a defined period. | `GONG_AGGREGATE_USER_ACTIVITY_STATISTICS` |
| Create activity scorecards report | 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. | `GONG_CREATE_ACTIVITY_SCORECARDS_REPORT` |
| Get interaction statistics | Retrieve interaction trend statistics for users based on calls with Whisper enabled. | `GONG_GET_INTERACTION_STATISTICS` |
| List all coaching metrics v2 coaching | List all of the coaching metrics of a manager. | `GONG_LIST_ALL_COACHING_METRICS_V2_COACHING` |
| Post day by day activity stats | Retrieve the daily activity of multiple users within the Gong system for a range of dates. | `GONG_POST_DAY_BY_DAY_ACTIVITY_STATS` |
| Action | What it does | Slug |
| --------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------- |
| List schema fields v2 CRM entity schema | Retrieves schema fields for a specific CRM object type within a Generic CRM integration. | `GONG_LIST_SCHEMA_FIELDS_V2_CRM_ENTITY_SCHEMA` |
| Action | What it does | Slug |
| --------------- | ----------------------------------------------- | ---------------------- |
| List scorecards | Retrieve all scorecards within the Gong system. | `GONG_LIST_SCORECARDS` |
| Action | What it does | Slug |
| ---------- | ------------------------------------------------------------------------- | ----------------- |
| List tasks | Retrieve Engage tasks assigned to a specific user with filtering options. | `GONG_LIST_TASKS` |
| Action | What it does | Slug |
| --------------------------------------------- | -------------------------------------------------------------------------------- | ---------------------------------------------------- |
| Retrieve tracker details v2 settings trackers | Retrieves details of all keyword trackers in the system or in a given workspace. | `GONG_RETRIEVE_TRACKER_DETAILS_V2_SETTINGS_TRACKERS` |
| Action | What it does | Slug |
| ------------------------------------------------- | ---------------------------------------------------- | -------------------------------------------------------- |
| Get call transcript | Retrieve call transcripts from Gong. | `GONG_GET_CALL_TRANSCRIPT` |
| Retrieve transcripts of calls v2 calls transcript | DEPRECATED: Use GONG\_GET\_CALL\_TRANSCRIPT instead. | `GONG_RETRIEVE_TRANSCRIPTS_OF_CALLS_V2_CALLS_TRANSCRIPT` |
| Action | What it does | Slug |
| --------------------------------------- | --------------------------------------------------------------------------------------- | ---------------------------------------------- |
| Get user by ID | Retrieve individual user details by user ID. | `GONG_GET_USER_BY_ID` |
| List all users v2 users | List all of the company's users. | `GONG_LIST_ALL_USERS_V2_USERS` |
| List users by filter v2 users extensive | List multiple Users. | `GONG_LIST_USERS_BY_FILTER_V2_USERS_EXTENSIVE` |
| Retrieve users from permission profile | Returns a list of all users whose access is controlled by the given permission profile. | `GONG_RETRIEVE_USERS_FROM_PERMISSION_PROFILE` |
| Action | What it does | Slug |
| ----------------------------------------- | --------------------------------------------------------- | ------------------------------------------------ |
| List all company workspaces v2 workspaces | Returns a list of all workspaces including their details. | `GONG_LIST_ALL_COMPANY_WORKSPACES_V2_WORKSPACES` |
| Action | What it does | Slug |
| ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- |
| Data privacy for phone number | Shows the elements in the Gong system that reference the given phone number. | `GONG_DATA_PRIVACY_FOR_PHONE_NUMBER` |
| Get flow prospects | Retrieve Gong Engage flows assigned to specified prospects. | `GONG_GET_FLOW_PROSPECTS` |
| Get request status v2 CRM request status | The GetCRMRequestStatus endpoint retrieves the current status of CRM integration requests in the Gong platform. | `GONG_GET_REQUEST_STATUS_V2_CRM_REQUEST_STATUS` |
| List Gong engage flows v2 flows | Engage flows have the following visibility types: Company: visible to everyone in the company, can only be edited by users with edit permissions. | `GONG_LIST_GONG_ENGAGE_FLOWS_V2_FLOWS` |
Agents can use 53 of the 58 Gong actions at this level: everything in **Read-only**, plus:
* View, share, and manage events
* Create and update meetings
* Create and update profiles
* Create calls
* Create integrations
* Create interactions
* Create media
* Create records
The 15 actions that this level adds to **Read-only**:
| Works on | Action | What it does | Slug |
| ----------------- | ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- |
| **Calls** | Add new call v2 calls | 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. | `GONG_ADD_NEW_CALL_V2_CALLS` |
| | Set user call access | Give individual users access to calls. | `GONG_SET_USER_CALL_ACCESS` |
| **Events** | Report content share event | Push content share engagement events to Gong's activity timeline. | `GONG_REPORT_CONTENT_SHARE_EVENT` |
| | Report content view event | Log content view engagement events to Gong's activity timeline. | `GONG_REPORT_CONTENT_VIEW_EVENT` |
| | Report custom engagement event | Report custom engagement events to Gong's activity timeline. | `GONG_REPORT_CUSTOM_ENGAGEMENT_EVENT` |
| **Integrations** | Register CRM integration | Updates an existing CRM integration in the Gong platform. | `GONG_REGISTER_CRM_INTEGRATION` |
| **Interactions** | Post a digital interaction v2 digital interaction | When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:digital-interactions:write'. | `GONG_POST_A_DIGITAL_INTERACTION_V2_DIGITAL_INTERACTION` |
| **Media** | Add call media v2 calls ID media | Adds a call media, recorded by a telephony system (PBX) or other media recording facility. | `GONG_ADD_CALL_MEDIA_V2_CALLS_ID_MEDIA` |
| **Meetings** | Create a new Gong meeting v2 meetings | When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:meetings:user:create'. | `GONG_CREATE_A_NEW_GONG_MEETING_V2_MEETINGS` |
| | Update a Gong meeting v2 meeting ID | When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:meetings:user:update'. | `GONG_UPDATE_A_GONG_MEETING_V2_MEETINGS_MEETING_ID` |
| **Profiles** | Create permission profile v2 permission profile | Create a permission profile in a given workspace. | `GONG_CREATE_PERMISSION_PROFILE_V2_PERMISSION_PROFILE` |
| | Update permission profile v2 permission profile | Update a permission profile. | `GONG_UPDATE_PERMISSION_PROFILE_V2_PERMISSION_PROFILE` |
| **Records** | Upload CRM objects v2 CRM entities | Uploads CRM entity data to Gong via LDJSON file. | `GONG_UPLOAD_CRM_OBJECTS_V2_CRM_ENTITIES` |
| **Other actions** | Assign prospects to flow | Prospects can be contacts or leads in your CRM. | `GONG_ASSIGN_PROSPECTS_TO_FLOW` |
| | Unassign flows by CRM ID | Unassign flows from prospects by their CRM Prospect ID. | `GONG_UNASSIGN_FLOWS_BY_CRM_ID` |
## Connect Gong
Before you start:
* You need a Gong account that you can sign in to.
* Your Squad subscription must be active. Squad does not connect apps while the subscription is not active.
Open **Settings** > **Integrations**.
On the **Connected apps** tab, click **+ Add integration**.
Find **Gong** in the catalog and click it. You can type the name in **Search the catalog…**.
Under **Default scope**, choose an access level. This level applies to every agent.
Click **Connect Gong**. The Gong sign-in page opens in a new tab.
Sign in to Gong and approve the request.
Check that it works: Gong shows under **YOUR CONNECTIONS**, with a row for the account and its access level.
## Change the access level
1. Under **YOUR CONNECTIONS**, find the Gong account.
2. Open the account menu (⋯) and click **Manage scope**.
3. Under **Default scope**, choose the new level.
4. Click **Save access**.
The change does not need a new sign-in. Agents get the new level from their next call.
## Set access for one agent
Every agent uses the account's level unless you set something else for it. You can narrow one agent to a lower level, or block it.
1. Under **YOUR CONNECTIONS**, open the account menu (⋯) on the Gong account.
2. Click **Manage scope**.
3. Under **Per-agent access**, find the agent.
4. Choose the **Default** option to follow the account's level, choose a lower level, or choose **No access**.
5. Click **Save access**.
An agent never gets more than the account's level, even if you choose a higher level for it. Changes apply from the agent's next call. An agent with **No access** does not see the account.
## Use more than one Gong account
Click **+ Account** on the Gong card to connect another account. Agents use the primary account unless they are asked to use a specific one.
* After you click **+ Account**, follow the connect steps above.
* Each account has its own access level.
* The first account you connect becomes the primary account. It shows **★ PRIMARY**.
* To change the primary account, open the account menu (⋯) and click **Make primary**.
* To tell accounts apart, open the account menu (⋯) and click **Rename**.
## Reconnect or disconnect
Reconnect when the connection has expired, or when you need to change what the account can reach on the Gong side:
1. Open the account menu (⋯) and click **Reconnect**.
2. Click **Reauthorize on Gong**.
3. Sign in to Gong and approve the request.
Reconnect signs in to the same account again. It does not add a second connection.
Open the account menu (⋯) on the Gong account and click **Disconnect**. Agents lose access to that account at once.
**Disconnect** acts at once, with no confirmation step. If it was the primary account, another connected Gong account becomes primary.
## Costs
Gong actions do not use Squad credits. Connected apps never use credits. For what does use credits, see [What Squad costs](/docs/costs).
## Troubleshooting
An agent reports that an action is not allowed on this account.
* Cause: the action is outside the account's access level, or outside the level you set for that agent.
* Fix: choose a higher level in **Manage scope**, or change the agent's row under **Per-agent access**.
An agent says it has no access to Gong, or it does not see the account.
* Cause: the agent is set to **No access** under **Per-agent access**, or the account is not connected.
* Fix: open **Manage scope** and change the agent's row. If the account is missing, connect it again.
Connecting or saving fails with "Your subscription isn't active."
* Cause: your Squad subscription is not active.
* Fix: resubscribe. See [Manage your subscription](/docs/billing).
An agent says the Gong connection has expired.
* Cause: the sign-in for that account is no longer valid.
* Fix: use **Reconnect** on the account.
## Common questions
Each Gong account has an access level: **Read-only** and **Read + write**. Squad refuses any agent action outside that level. You can also narrow or block single agents under **Per-agent access**.
Click **+ Account** on the Gong card to connect another account. Agents use the primary account unless they are asked to use a specific one.
Open the account menu (⋯) on the Gong account and click **Disconnect**. Agents lose access to that account at once.
## Related pages
Use this when an action you need is not in this app.