Gong: List Multiple Users

List users by filter (/v2/users/extensive).

Tool ID: gong_list_multiple_users

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_list_multiple_users',
  {
    "filter": {
      "createdFromDateTime": "2026-01-15T12:00:00Z",
      "createdToDateTime": "2026-01-15T12:00:00Z",
      "includeAvatars": true
    }
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute gong_list_multiple_users --input '{
  "filter": {
    "createdFromDateTime": "2026-01-15T12:00:00Z",
    "createdToDateTime": "2026-01-15T12:00:00Z",
    "includeAvatars": true
  }
}' --json

Example response

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

{
  "data": {
    "requestId": "request_123",
    "records": {
      "totalRecords": 123,
      "currentPageSize": 123,
      "currentPageNumber": 123
    },
    "users": [
      {
        "id": "id_123",
        "emailAddress": "jane.doe@example.com",
        "created": "example"
      }
    ]
  }
}

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

Input reference

List multiple Users. When accessed through a Bearer token authorization method, this endpoint requires the scope ‘api:users:read’.

Name	Type	Required	Default	Details
`payload.cursor`	`string`	No	—	When paging is needed, provide the value supplied by the previous API call to bring the following page of records.
`payload.filter`	`object`	Yes	—	Filter parameters.

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.records`	`object`	No	—	Information about the number of records that match the requested filter.
`result.data.records.totalRecords`	`integer`	No	—	Total number of records. Format: `int32`.
`result.data.records.currentPageSize`	`integer`	No	—	Number of records in the current page. Format: `int32`.
`result.data.records.currentPageNumber`	`integer`	No	—	Current page number. Format: `int32`.
`result.data.records.cursor`	`string`	No	—	Returned only when there are more records to be retrieved. Repeat the API call and pass this cursor value in the request to retrieve the next page of records.
`result.data.users`	`array`	No	—	A list, in which each item specifies one user’s metadata.
`result.data.users[].id`	`string`	No	—	Gong’s unique numeric identifier for the user (up to 20 digits).
`result.data.users[].emailAddress`	`string`	No	—	The email address of the Gong user.
`result.data.users[].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.users[].active`	`boolean`	No	—	True if the user is active, false if not.
`result.data.users[].emailAliases`	`array`	No	—	List of email address aliases of the Gong user.
`result.data.users[].trustedEmailAddress`	`string`	No	—	The trusted authentication email assigned to the Gong user
`result.data.users[].firstName`	`string`	No	—	The first name of the Gong user.
`result.data.users[].lastName`	`string`	No	—	The last name of the Gong user.
`result.data.users[].title`	`string`	No	—	The job title of the Gong user.
`result.data.users[].phoneNumber`	`string`	No	—	The phone number of the Gong user.
`result.data.users[].extension`	`string`	No	—	The extension number of the Gong user.
`result.data.users[].personalMeetingUrls`	`array`	No	—	The list of personal meeting URLs of the Gong user.
`result.data.users[].settings`	`object`	No	—	The user’s settings in the Gong system.
`result.data.users[].settings.webConferencesRecorded`	`boolean`	No	—	True if the team member is set to be recorded by Gong, false if not.
`result.data.users[].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.users[].settings.telephonyCallsImported`	`boolean`	No	—	True if the team member is set to import telephony calls from by Gong, false if not.
`result.data.users[].settings.emailsImported`	`boolean`	No	—	True if the team member is set to import emails by Gong, false if not.
`result.data.users[].settings.preventEmailImport`	`boolean`	No	—	True if the team member is set to prevent import of emails by Gong, false if not.
`result.data.users[].settings.nonRecordedMeetingsImported`	`boolean`	No	—	True if the team member is set to import non recorded meetings by Gong, false if not.
`result.data.users[].settings.gongConnectEnabled`	`boolean`	No	—	True if the team member has Gong Connect enabled, false if not.
`result.data.users[].managerId`	`string`	No	—	The manager ID of the Gong user.
`result.data.users[].meetingConsentPageUrl`	`string`	No	—	The Gong recording consent meeting link
`result.data.users[].conferencingProviders`	`array`	No	—	The list of web conferencing providers configured for this user, including which is the default.
`result.data.users[].conferencingProviders[].provider`	`string`	No	—	The provider identifier.
`result.data.users[].conferencingProviders[].isDefault`	`boolean`	No	—	True if this is the user’s default conferencing provider.
`result.data.users[].spokenLanguages`	`array`	No	—	—
`result.data.users[].spokenLanguages[].language`	`string`	No	—	Language spoken by the user encoded according to the BCP-47 standard.
`result.data.users[].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

Gong: List Multiple Users

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