> ## 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: List Users

> List all users in your Gong company. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

List all users in your Gong company.

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

## 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_list_users',
  {
    "cursor": "cursor_123",
    "includeAvatars": true
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute gong_list_users --input '{
  "cursor": "cursor_123",
  "includeAvatars": true
}' --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",
    "records": {
      "totalRecords": 123,
      "currentPageSize": 123,
      "currentPageNumber": 123
    },
    "users": [
      {
        "id": "id_123",
        "emailAddress": "jane.doe@example.com",
        "created": "example"
      }
    ]
  }
}
```

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

## Input reference

List all of the company's 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.includeAvatars` | `boolean` | No | — | 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. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "List all of the company's users. When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:users:read'.",
    "properties": {
      "cursor": {
        "type": "string",
        "description": "When paging is needed, provide the value supplied by the previous API call to bring the following page of records."
      },
      "includeAvatars": {
        "type": "boolean",
        "description": "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."
      }
    },
    "required": [],
    "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.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). |

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

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "requestId": {
            "type": "string",
            "description": "A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes."
          },
          "records": {
            "type": "object",
            "description": "Information about the number of records that match the requested filter.",
            "properties": {
              "totalRecords": {
                "type": "integer",
                "description": "Total number of records.",
                "format": "int32"
              },
              "currentPageSize": {
                "type": "integer",
                "description": "Number of records in the current page.",
                "format": "int32"
              },
              "currentPageNumber": {
                "type": "integer",
                "description": "Current page number.",
                "format": "int32"
              },
              "cursor": {
                "type": "string",
                "description": "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."
              }
            },
            "additionalProperties": false
          },
          "users": {
            "type": "array",
            "description": "A list, in which each item specifies one user's metadata.",
            "items": {
              "type": "object",
              "description": "User's metadata.",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Gong's unique numeric identifier for the user (up to 20 digits)."
                },
                "emailAddress": {
                  "type": "string",
                  "description": "The email address of the Gong user."
                },
                "created": {
                  "type": "string",
                  "description": "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."
                },
                "active": {
                  "type": "boolean",
                  "description": "True if the user is active, false if not."
                },
                "emailAliases": {
                  "type": "array",
                  "description": "List of email address aliases of the Gong user.",
                  "items": {
                    "type": "string"
                  }
                },
                "trustedEmailAddress": {
                  "type": "string",
                  "description": "The trusted authentication email assigned to the Gong user"
                },
                "firstName": {
                  "type": "string",
                  "description": "The first name of the Gong user."
                },
                "lastName": {
                  "type": "string",
                  "description": "The last name of the Gong user."
                },
                "title": {
                  "type": "string",
                  "description": "The job title of the Gong user."
                },
                "phoneNumber": {
                  "type": "string",
                  "description": "The phone number of the Gong user."
                },
                "extension": {
                  "type": "string",
                  "description": "The extension number of the Gong user."
                },
                "personalMeetingUrls": {
                  "type": "array",
                  "description": "The list of personal meeting URLs of the Gong user.",
                  "items": {
                    "type": "string"
                  }
                },
                "settings": {
                  "type": "object",
                  "description": "The user's settings in the Gong system.",
                  "properties": {
                    "webConferencesRecorded": {
                      "type": "boolean",
                      "description": "True if the team member is set to be recorded by Gong, false if not."
                    },
                    "preventWebConferenceRecording": {
                      "type": "boolean",
                      "description": "If true, invitation of this user to a web conference will prevent its recording (even if other users invited are set to record)."
                    },
                    "telephonyCallsImported": {
                      "type": "boolean",
                      "description": "True if the team member is set to import telephony calls from by Gong, false if not."
                    },
                    "emailsImported": {
                      "type": "boolean",
                      "description": "True if the team member is set to import emails by Gong, false if not."
                    },
                    "preventEmailImport": {
                      "type": "boolean",
                      "description": "True if the team member is set to prevent import of emails by Gong, false if not."
                    },
                    "nonRecordedMeetingsImported": {
                      "type": "boolean",
                      "description": "True if the team member is set to import non recorded meetings by Gong, false if not."
                    },
                    "gongConnectEnabled": {
                      "type": "boolean",
                      "description": "True if the team member has Gong Connect enabled, false if not."
                    }
                  },
                  "additionalProperties": false
                },
                "managerId": {
                  "type": "string",
                  "description": "The manager ID of the Gong user."
                },
                "meetingConsentPageUrl": {
                  "type": "string",
                  "description": "The Gong recording consent meeting link"
                },
                "conferencingProviders": {
                  "type": "array",
                  "description": "The list of web conferencing providers configured for this user, including which is the default.",
                  "items": {
                    "type": "object",
                    "description": "A web conferencing provider configured in the user's consent profile",
                    "properties": {
                      "provider": {
                        "type": "string",
                        "description": "The provider identifier."
                      },
                      "isDefault": {
                        "type": "boolean",
                        "description": "True if this is the user's default conferencing provider."
                      }
                    },
                    "additionalProperties": false
                  }
                },
                "spokenLanguages": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "description": "Languages spoken during calls by the Gong user",
                    "properties": {
                      "language": {
                        "type": "string",
                        "description": "Language spoken by the user encoded according to the BCP-47 standard."
                      },
                      "primary": {
                        "type": "boolean",
                        "description": "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."
                      }
                    },
                    "additionalProperties": false
                  }
                }
              },
              "additionalProperties": false
            }
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## 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.