> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Gong: Get Permission Profile

> Get one Gong permission profile and its access settings by profile ID. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Get one Gong permission profile and its access settings by profile ID.

> [!NOTE]
>
> Tool ID: `gong_get_permission_profile`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'gong_get_permission_profile',
  {
    "profileId": "profile_123"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute gong_get_permission_profile --input '{
  "profileId": "profile_123"
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "requestId": "request_123",
    "profile": {
      "id": "id_123",
      "name": "Example",
      "description": "Example description"
    }
  }
}
```

Use `deepline describe gong_get_permission_profile --json` for the latest machine-readable contract.

## Input reference

Returns a permission profile.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.profileId` | `string` | Yes | — | Permission profile identifier. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Returns a permission profile.",
    "properties": {
      "profileId": {
        "type": "string",
        "description": "Permission profile identifier."
      }
    },
    "required": [
      "profileId"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.requestId` | `string` | No | — | A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes. |
| `result.data.profile` | `object` | No | — | Permission profile |
| `result.data.profile.id` | `string` | No | — | Unique numeric identifier of the permission profile (up to 20 digits). |
| `result.data.profile.name` | `string` | No | — | Permission profile name. |
| `result.data.profile.description` | `string` | No | — | Permission profile description. |
| `result.data.profile.callsAccess` | `object` | No | — | Calls access permission. |
| `result.data.profile.callsAccess.permissionLevel` | `"all" \| "managers-team" \| "report-to-them" \| "own" \| "none" \| "all / managers-team / report-to-them / own / none"` | No | — | Permission access scope. Allowed: `all`, `managers-team`, `report-to-them`, `own`, `none`, `all / managers-team / report-to-them / own / none`. |
| `result.data.profile.callsAccess.teamLeadIds` | `array` | No | — | List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API. Items must be unique. |
| `result.data.profile.libraryFolderAccess` | `object` | No | — | Library folder access permission. |
| `result.data.profile.libraryFolderAccess.permissionLevel` | `"none" \| "all" \| "specific-folders" \| "none, all, specific-folders"` | No | — | Library folder permission level - mandatory value. Allowed: `none`, `all`, `specific-folders`, `none, all, specific-folders`. |
| `result.data.profile.libraryFolderAccess.libraryFolderIds` | `array` | No | — | List of library folder Ids, if set, "permissionLevel" must not be "none". Items must be unique. |
| `result.data.profile.libraryFolderAccess.managePublicFolder` | `boolean` | No | — | A user with this profile can manage public folder, if set, "permissionLevel" must not be "none". |
| `result.data.profile.libraryFolderAccess.manageStreams` | `boolean` | No | — | A user with this profile can manage streams, if set, "permissionLevel" must not be "none". |
| `result.data.profile.libraryFolderAccess.manageFolderCalls` | `boolean` | No | — | A user with this profile can add calls to folders, archive calls, if set, "permissionLevel" must not be "none". |
| `result.data.profile.libraryFolderAccess.shareFoldersAndStreams` | `boolean` | No | — | A user with this profile can share folders and streams from Your Library with other team members, if set, "permissionLevel" must not be "none". |
| `result.data.profile.dealsAccess` | `object` | No | — | Deals access permission. |
| `result.data.profile.dealsAccess.permissionLevel` | `"all" \| "managers-team" \| "report-to-them" \| "own" \| "none" \| "all / managers-team / report-to-them / own / none"` | No | — | Permission access scope. Allowed: `all`, `managers-team`, `report-to-them`, `own`, `none`, `all / managers-team / report-to-them / own / none`. |
| `result.data.profile.dealsAccess.teamLeadIds` | `array` | No | — | List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API. Items must be unique. |
| `result.data.profile.forecastPermissions` | `object` | No | — | All forecast permissions. |
| `result.data.profile.forecastPermissions.forecastAccess` | `object` | No | — | User can view forecast submissions. |
| `result.data.profile.forecastPermissions.forecastAccess.permissionLevel` | `"all" \| "managers-team" \| "report-to-them" \| "own" \| "none" \| "all / managers-team / report-to-them / own / none"` | No | — | Permission access scope. Allowed: `all`, `managers-team`, `report-to-them`, `own`, `none`, `all / managers-team / report-to-them / own / none`. |
| `result.data.profile.forecastPermissions.forecastAccess.teamLeadIds` | `array` | No | — | List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API. Items must be unique. |
| `result.data.profile.forecastPermissions.forecastEditSubmissions` | `object` | No | — | User can edit forecasts submissions. |
| `result.data.profile.forecastPermissions.forecastEditSubmissions.permissionLevel` | `"all" \| "managers-team" \| "report-to-them" \| "own" \| "none" \| "all / managers-team / report-to-them / own / none"` | No | — | Permission access scope. Allowed: `all`, `managers-team`, `report-to-them`, `own`, `none`, `all / managers-team / report-to-them / own / none`. |
| `result.data.profile.forecastPermissions.forecastEditSubmissions.teamLeadIds` | `array` | No | — | List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API. Items must be unique. |
| `result.data.profile.forecastPermissions.forecastEditTargets` | `object` | No | — | User can edit forecast Targets. |
| `result.data.profile.forecastPermissions.forecastEditTargets.permissionLevel` | `"all" \| "managers-team" \| "report-to-them" \| "own" \| "none" \| "all / managers-team / report-to-them / own / none"` | No | — | Permission access scope. Allowed: `all`, `managers-team`, `report-to-them`, `own`, `none`, `all / managers-team / report-to-them / own / none`. |
| `result.data.profile.forecastPermissions.forecastEditTargets.teamLeadIds` | `array` | No | — | List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API. Items must be unique. |
| `result.data.profile.coachingAccess` | `object` | No | — | Coaching access permission. |
| `result.data.profile.coachingAccess.permissionLevel` | `"all" \| "managers-team" \| "report-to-them" \| "own" \| "none" \| "all / managers-team / report-to-them / own / none"` | No | — | Permission access scope. Allowed: `all`, `managers-team`, `report-to-them`, `own`, `none`, `all / managers-team / report-to-them / own / none`. |
| `result.data.profile.coachingAccess.teamLeadIds` | `array` | No | — | List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API. Items must be unique. |
| `result.data.profile.insightsAccess` | `object` | No | — | Insights access permission. |
| `result.data.profile.insightsAccess.permissionLevel` | `"all" \| "managers-team" \| "report-to-them" \| "own" \| "none" \| "all / managers-team / report-to-them / own / none"` | No | — | Permission access scope. Allowed: `all`, `managers-team`, `report-to-them`, `own`, `none`, `all / managers-team / report-to-them / own / none`. |
| `result.data.profile.insightsAccess.teamLeadIds` | `array` | No | — | List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API. Items must be unique. |
| `result.data.profile.usageAccess` | `object` | No | — | Usage access permission. |
| `result.data.profile.usageAccess.permissionLevel` | `"all" \| "managers-team" \| "report-to-them" \| "own" \| "none" \| "all / managers-team / report-to-them / own / none"` | No | — | Permission access scope. Allowed: `all`, `managers-team`, `report-to-them`, `own`, `none`, `all / managers-team / report-to-them / own / none`. |
| `result.data.profile.usageAccess.teamLeadIds` | `array` | No | — | List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API. Items must be unique. |
| `result.data.profile.emailsAccess` | `object` | No | — | Emails access permission. |
| `result.data.profile.emailsAccess.permissionLevel` | `"all" \| "managers-team" \| "report-to-them" \| "own" \| "none" \| "all / managers-team / report-to-them / own / none"` | No | — | Permission access scope. Allowed: `all`, `managers-team`, `report-to-them`, `own`, `none`, `all / managers-team / report-to-them / own / none`. |
| `result.data.profile.emailsAccess.teamLeadIds` | `array` | No | — | List of user IDs to populate the managers-team permission level You can retrieve the user ids by using the “Users” API. Items must be unique. |
| `result.data.profile.scoreCalls` | `boolean` | No | — | User can score calls. |
| `result.data.profile.overrideScore` | `boolean` | No | — | User can override someone else score. |
| `result.data.profile.downloadCallMedia` | `boolean` | No | — | User can download call media. |
| `result.data.profile.shareCallsWithCustomers` | `boolean` | No | — | User can share calls with customers. |
| `result.data.profile.manuallyScheduleAndUploadCalls` | `boolean` | No | — | User can manually schedule and upload calls. |
| `result.data.profile.privateCalls` | `boolean` | No | — | User can set their own calls as private. |
| `result.data.profile.deleteCalls` | `boolean` | No | — | User can delete calls. |
| `result.data.profile.trimCalls` | `boolean` | No | — | User can trim calls. |
| `result.data.profile.listenInCalls` | `boolean` | No | — | User can listen in calls. |

The table shows the first 50 fields. Use the live contract below for every field.

> [!NOTE]
>
> This output schema is too large for an inline display. Read the complete live contract with `deepline describe gong_get_permission_profile --json`.

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [Gong provider guide](https://deepline.com/docs/providers/gong/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.