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 users (/v2/users)

Prev Next
Get
/v2/users

List all of the company's users.

Required authorizaton scope: 'api:users:read'.

Query parameters
cursor
string

When paging is needed, provide the value supplied by the previous API call to bring the following page of records.

ExampleeyJhbGciOiJIUzI1NiJ9.eyJjYWxsSWQiM1M30.6qKwpOcvnuweTZmFRzYdtjs_YwJphJU4QIwWFM
includeAvatars
boolean

Avatars are synthetic users representing Gong employees (CSMs and support providers) when they access your instance. References to avatars' IDs may be found in the outputs of other API endpoints. This parameter is optional, if not provided avatars will not be included in the results.

Examplefalse
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
records
object (Records)

Information about the number of records that match the requested filter.

totalRecords
integer (int32)

Total number of records.

Example263
currentPageSize
integer (int32)

Number of records in the current page.

Example100
currentPageNumber
integer (int32)

Current page number.

Example0
cursor
string

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.

ExampleeyJhbGciOiJIUzI1NiJ9.eyJjYWxsSWQiM1M30.6qKwpOcvnuweTZmFRzYdtjs_YwJphJU4QIwWFM
users
Array of object (UserMetadata)

A list, in which each item specifies one user's metadata.

object

User's metadata.

id
string

Gong's unique numeric identifier for the user (up to 20 digits).

Example234599484848423
emailAddress
string

The email address of the Gong user.

Exampletest@test.com
created
string

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.

Example2018-02-17T02:30:00-08:00
active
boolean

True if the user is active, false if not.

Exampletrue
emailAliases
Array of string

List of email address aliases of the Gong user.

Example[ "testAlias@test.com" ]
string
trustedEmailAddress
string

The trusted authentication email assigned to the Gong user

Exampletest@test.com
firstName
string

The first name of the Gong user.

ExampleJon
lastName
string

The last name of the Gong user.

ExampleSnow
title
string

The job title of the Gong user.

ExampleEnterprise Account Executive
phoneNumber
string

The phone number of the Gong user.

Example+1 123-567-8989
extension
string

The extension number of the Gong user.

Example123
personalMeetingUrls
Array of string

The list of personal meeting URLs of the Gong user.

Example[ "https://zoom.us/j/123" ]
string
settings
object (Settings)

The user's settings in the Gong system.

webConferencesRecorded
boolean

True if the team member is set to be recorded by Gong, false if not.

Exampletrue
preventWebConferenceRecording
boolean

If true, invitation of this user to a web conference will prevent its recording (even if other users invited are set to record).

telephonyCallsImported
boolean

True if the team member is set to import telephony calls from by Gong, false if not.

emailsImported
boolean

True if the team member is set to import emails by Gong, false if not.

Exampletrue
preventEmailImport
boolean

True if the team member is set to prevent import of emails by Gong, false if not.

nonRecordedMeetingsImported
boolean

True if the team member is set to import non recorded meetings by Gong, false if not.

Exampletrue
gongConnectEnabled
boolean

True if the team member has Gong Connect enabled, false if not.

Exampletrue
managerId
string

The manager ID of the Gong user.

Example563515258458745
meetingConsentPageUrl
string

The Gong recording consent meeting link

Examplehttps://join.gong.io/my-company/jon.snow?tkn=MoNpS9tMNt8BK7EZxQpSJl
spokenLanguages
Array of object (spokenLanguage)
object

Languages spoken during calls by the Gong user

language
string

Language spoken by the user encoded according to the BCP-47 standard.

Examplees-ES
primary
boolean

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.

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
403

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
429

API request limit exceeded

Headers
Retry-After
integer
Number of seconds to wait before making a new 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
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