Documentation Index

Fetch the complete documentation index at: https://help.gong.io/llms.txt

Use this file to discover all available pages before exploring further.

List all company permission profiles for a given workspace (/v2/all-permission-profiles)

Prev Next
Get
/v2/all-permission-profiles

Returns a list of all permission profiles.

The listing is in the alphabetical order of the profile names.

Query parameters
workspaceId
stringRequired

Workspace identifier, the API will return only the profiles belonging to this workspace.

You can retrieve the workspace using the "workspaces" (under "Settings") API.

Responses
200

Successful response

Expand All
object
requestId
string

A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.

Example4al018gzaztcr8nbukw
profiles
Array of object (PermissionProfileDTO)

A list, in which each item specifies a permission profile.

object

Permission profile

id
string

Unique numeric identifier of the permission profile (up to 20 digits).

Example3843152912968920037
name
string

Permission profile name.

ExampleProfile
description
string

Permission profile description.

ExampleDescription
callsAccess
object (CallAccessWithPermissionLevel)

Calls access permission.

permissionLevel
string

Permission access scope.

Valid values[ "all", "managers-team", "report-to-them", "own", "none", "all / managers-team / report-to-them / own / none" ]
teamLeadIds
Array of string

List of user IDs to populate the managers-team permission level

You can retrieve the user ids by using the “Users” API.

Example[ "295738305212375930" ]
string

List of user IDs to populate the managers-team permission level

You can retrieve the user ids by using the “Users” API.

Example["295738305212375930"]
libraryFolderAccess
object (LibraryFolderAccess)

Library folder access permission.

permissionLevel
string

Library folder permission level - mandatory value.

Valid values[ "none", "all", "specific-folders", "none, all, specific-folders" ]
libraryFolderIds
Array of string

List of library folder Ids, if set, "permissionLevel" must not be "none".

Example[ "3843152912968920037" ]
string

List of library folder Ids, if set, "permissionLevel" must not be "none".

Example["3843152912968920037"]
managePublicFolder
boolean

A user with this profile can manage public folder, if set, "permissionLevel" must not be "none".

Exampletrue
manageStreams
boolean

A user with this profile can manage streams, if set, "permissionLevel" must not be "none".

Exampletrue
manageFolderCalls
boolean

A user with this profile can add calls to folders, archive calls, if set, "permissionLevel" must not be "none".

Exampletrue
shareFoldersAndStreams
boolean

A user with this profile can share folders and streams from Your Library with other team members, if set, "permissionLevel" must not be "none".

Exampletrue
dealsAccess
object (DealsAccessWithPermissionLevel)

Deals access permission.

permissionLevel
string

Permission access scope.

Valid values[ "all", "managers-team", "report-to-them", "own", "none", "all / managers-team / report-to-them / own / none" ]
teamLeadIds
Array of string

List of user IDs to populate the managers-team permission level

You can retrieve the user ids by using the “Users” API.

Example[ "295738305212375930" ]
string

List of user IDs to populate the managers-team permission level

You can retrieve the user ids by using the “Users” API.

Example["295738305212375930"]
forecastPermissions
object (ForecastPermissions)

All forecast permissions.

forecastAccess
object (ForecastAccess)

User can view forecast submissions.

permissionLevel
string

Permission access scope.

Valid values[ "all", "managers-team", "report-to-them", "own", "none", "all / managers-team / report-to-them / own / none" ]
teamLeadIds
Array of string

List of user IDs to populate the managers-team permission level

You can retrieve the user ids by using the “Users” API.

Example[ "295738305212375930" ]
string

List of user IDs to populate the managers-team permission level

You can retrieve the user ids by using the “Users” API.

Example["295738305212375930"]
forecastEditSubmissions
object (ForecastEditSubmissions)

User can edit forecasts submissions.

permissionLevel
string

Permission access scope.

Valid values[ "all", "managers-team", "report-to-them", "own", "none", "all / managers-team / report-to-them / own / none" ]
teamLeadIds
Array of string

List of user IDs to populate the managers-team permission level

You can retrieve the user ids by using the “Users” API.

Example[ "295738305212375930" ]
string

List of user IDs to populate the managers-team permission level

You can retrieve the user ids by using the “Users” API.

Example["295738305212375930"]
forecastEditTargets
object (ForecastEditTargets)

User can edit forecast Targets.

permissionLevel
string

Permission access scope.

Valid values[ "all", "managers-team", "report-to-them", "own", "none", "all / managers-team / report-to-them / own / none" ]
teamLeadIds
Array of string

List of user IDs to populate the managers-team permission level

You can retrieve the user ids by using the “Users” API.

Example[ "295738305212375930" ]
string

List of user IDs to populate the managers-team permission level

You can retrieve the user ids by using the “Users” API.

Example["295738305212375930"]
coachingAccess
object (CoachingAccessWithPermissionLevel)

Coaching access permission.

permissionLevel
string

Permission access scope.

Valid values[ "all", "managers-team", "report-to-them", "own", "none", "all / managers-team / report-to-them / own / none" ]
teamLeadIds
Array of string

List of user IDs to populate the managers-team permission level

You can retrieve the user ids by using the “Users” API.

Example[ "295738305212375930" ]
string

List of user IDs to populate the managers-team permission level

You can retrieve the user ids by using the “Users” API.

Example["295738305212375930"]
insightsAccess
object (InsightsAccessWithPermissionLevel)

Insights access permission.

permissionLevel
string

Permission access scope.

Valid values[ "all", "managers-team", "report-to-them", "own", "none", "all / managers-team / report-to-them / own / none" ]
teamLeadIds
Array of string

List of user IDs to populate the managers-team permission level

You can retrieve the user ids by using the “Users” API.

Example[ "295738305212375930" ]
string

List of user IDs to populate the managers-team permission level

You can retrieve the user ids by using the “Users” API.

Example["295738305212375930"]
usageAccess
object (UsageAccessWithPermissionLevel)

Usage access permission.

permissionLevel
string

Permission access scope.

Valid values[ "all", "managers-team", "report-to-them", "own", "none", "all / managers-team / report-to-them / own / none" ]
teamLeadIds
Array of string

List of user IDs to populate the managers-team permission level

You can retrieve the user ids by using the “Users” API.

Example[ "295738305212375930" ]
string

List of user IDs to populate the managers-team permission level

You can retrieve the user ids by using the “Users” API.

Example["295738305212375930"]
emailsAccess
object (EmailsAccessWithPermissionLevel)

Emails access permission.

permissionLevel
string

Permission access scope.

Valid values[ "all", "managers-team", "report-to-them", "own", "none", "all / managers-team / report-to-them / own / none" ]
teamLeadIds
Array of string

List of user IDs to populate the managers-team permission level

You can retrieve the user ids by using the “Users” API.

Example[ "295738305212375930" ]
string

List of user IDs to populate the managers-team permission level

You can retrieve the user ids by using the “Users” API.

Example["295738305212375930"]
scoreCalls
boolean

User can score calls.

Exampletrue
overrideScore
boolean

User can override someone else score.

Exampletrue
downloadCallMedia
boolean

User can download call media.

Exampletrue
shareCallsWithCustomers
boolean

User can share calls with customers.

Exampletrue
manuallyScheduleAndUploadCalls
boolean

User can manually schedule and upload calls.

Exampletrue
privateCalls
boolean

User can set their own calls as private.

Exampletrue
deleteCalls
boolean

User can delete calls.

Exampletrue
trimCalls
boolean

User can trim calls.

Exampletrue
listenInCalls
boolean

User can listen in calls.

Exampletrue
deleteEmails
boolean

User can delete emails.

Exampletrue
callsAndSearch
boolean

User can view and search calls.

Exampletrue
library
boolean

User can view library pages.

Exampletrue
deals
boolean

User can view deals pages.

Exampletrue
createEditAndDeleteDealsBoards
boolean

User can create/edit/delete deals boards.

Exampletrue
dealsInlineEditing
boolean

User can perform inline editing of deals.

Exampletrue
account
boolean

User can view account pages.

Exampletrue
coaching
boolean

User can view coaching pages.

Exampletrue
usage
boolean

User can view usage pages.

Exampletrue
teamStats
boolean

User can view team stats page.

Exampletrue
initiatives
boolean

User can view initiatives page.

Exampletrue
market
boolean

User can view market page.

Exampletrue
activity
boolean

User can view activity pages.

Exampletrue
forecast
boolean

User can view forecast pages.

Exampletrue
forecastManage
boolean

User can manage forecast boards and upload targets.

Exampletrue
engageManageCompanyTemplates
boolean

User can manage company email templates.

Exampletrue
engageManageCompanySequences
boolean

User can manage company sequences.

Exampletrue
engageCreateAndManageRulesets
boolean

User can create and manage rulesets.

Exampletrue
engageSnoozeFlowToDosForOthers
boolean

User can snooze flow in to dos for others

Exampletrue
engageAllowCrmFieldsViewChange
boolean

User can change crm fields view

Exampletrue
viewEngageAnalyticsActivity
boolean

User can view engage analytics activity page.

Exampletrue
viewEngageAnalyticsPerformance
boolean

User can view engage analytics performance page.

Exampletrue
viewEngageAnalyticsFlows
boolean

User can view engage analytics flows page.

Exampletrue
manageGeneralBusinessSettings
boolean

User can manage general business settings.

Exampletrue
manageScorecards
boolean

User can manage scorecards.

Exampletrue
exportCallsAndCoachingDataToCSV
boolean

User can export calls and coaching metrics data to CSV.

Exampletrue
crmDataInlineEditing
boolean

User can perform inline editing of crm data.

Exampletrue
crmDataImport
boolean

User can perform import of crm data.

Exampletrue
viewRevenueAnalytics
boolean

User can view dashboards page.

Exampletrue
manageRevenueAnalytics
boolean

User can manage revenue analytics.

Exampletrue
engageReassignFlowToDosToOthers
boolean

User can reassign flow to-dos to others

Exampletrue
engageAssignFlowToDosToOthers
boolean

User can assign flow to-dos to others

Exampletrue
dealsDataExport
boolean

User can export deals data

Exampletrue
400

Malformed request

object
requestId
string

A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.

Example4al018gzaztcr8nbukw
errors
Array of string

Error messages.

Example[ "An error has occurred" ]
string
401

Access denied

object
requestId
string

A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.

Example4al018gzaztcr8nbukw
errors
Array of string

Error messages.

Example[ "An error has occurred" ]
string
500

Failed to complete the operation due to an unexpected error

object
requestId
string

A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes.

Example4al018gzaztcr8nbukw
errors
Array of string

Error messages.

Example[ "An error has occurred" ]
string