Gong: Get User

Retrieve user (/v2/users/{id}).

Tool ID: gong_get_user

Run this action

Use the TypeScript SDK for a single call. Put ctx.tools.execute(...) inside a Play when the call should be durable, scheduled, or run across a CSV.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'gong_get_user',
  {
    "id": "id_123"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute gong_get_user --input '{
  "id": "id_123"
}' --json

Example response

The SDK exposes this shape at result.toolResponse.raw. Values below are representative.

{
  "data": {
    "requestId": "request_123",
    "user": {
      "id": "id_123",
      "emailAddress": "jane.doe@example.com",
      "created": "example"
    }
  }
}

Use deepline tools get gong_get_user --json for the latest machine-readable contract.

Input reference

Retrieve a specific user. When accessed through a Bearer token authorization method, this endpoint requires the scope ‘api:users:read’.

Name	Type	Required	Default	Details
`payload.id`	`string`	Yes	—	Gong’s unique numeric identifier for the user (up to 20 digits).

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.user`	`object`	No	—	User’s metadata.
`result.data.user.id`	`string`	No	—	Gong’s unique numeric identifier for the user (up to 20 digits).
`result.data.user.emailAddress`	`string`	No	—	The email address of the Gong user.
`result.data.user.created`	`string`	No	—	Creation time in the ISO-8601 format (e.g., ‘2018-02-18T02:30:00-07:00’ or ‘2018-02-18T08:00:00Z’, where Z stands for UTC);of the Gong user.
`result.data.user.active`	`boolean`	No	—	True if the user is active, false if not.
`result.data.user.emailAliases`	`array`	No	—	List of email address aliases of the Gong user.
`result.data.user.trustedEmailAddress`	`string`	No	—	The trusted authentication email assigned to the Gong user
`result.data.user.firstName`	`string`	No	—	The first name of the Gong user.
`result.data.user.lastName`	`string`	No	—	The last name of the Gong user.
`result.data.user.title`	`string`	No	—	The job title of the Gong user.
`result.data.user.phoneNumber`	`string`	No	—	The phone number of the Gong user.
`result.data.user.extension`	`string`	No	—	The extension number of the Gong user.
`result.data.user.personalMeetingUrls`	`array`	No	—	The list of personal meeting URLs of the Gong user.
`result.data.user.settings`	`object`	No	—	The user’s settings in the Gong system.
`result.data.user.settings.webConferencesRecorded`	`boolean`	No	—	True if the team member is set to be recorded by Gong, false if not.
`result.data.user.settings.preventWebConferenceRecording`	`boolean`	No	—	If true, invitation of this user to a web conference will prevent its recording (even if other users invited are set to record).
`result.data.user.settings.telephonyCallsImported`	`boolean`	No	—	True if the team member is set to import telephony calls from by Gong, false if not.
`result.data.user.settings.emailsImported`	`boolean`	No	—	True if the team member is set to import emails by Gong, false if not.
`result.data.user.settings.preventEmailImport`	`boolean`	No	—	True if the team member is set to prevent import of emails by Gong, false if not.
`result.data.user.settings.nonRecordedMeetingsImported`	`boolean`	No	—	True if the team member is set to import non recorded meetings by Gong, false if not.
`result.data.user.settings.gongConnectEnabled`	`boolean`	No	—	True if the team member has Gong Connect enabled, false if not.
`result.data.user.managerId`	`string`	No	—	The manager ID of the Gong user.
`result.data.user.meetingConsentPageUrl`	`string`	No	—	The Gong recording consent meeting link
`result.data.user.conferencingProviders`	`array`	No	—	The list of web conferencing providers configured for this user, including which is the default.
`result.data.user.conferencingProviders[].provider`	`string`	No	—	The provider identifier.
`result.data.user.conferencingProviders[].isDefault`	`boolean`	No	—	True if this is the user’s default conferencing provider.
`result.data.user.spokenLanguages`	`array`	No	—	—
`result.data.user.spokenLanguages[].language`	`string`	No	—	Language spoken by the user encoded according to the BCP-47 standard.
`result.data.user.spokenLanguages[].primary`	`boolean`	No	—	Indicates the primary language (one per user). The language will be assumed when the system cannot identify the language of a call, e.g., due to poor quality or the call being too short.
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

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

Get started

Build and automate

Common workflows

Data and integrations

Reference

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation