Retrieve a list of all users given a Customer ID or a Domain.
External DocumentationTo learn more, visit the Google Admin Console documentation.

​
Basic Parameters

ParameterDescription
Customer IDThe unique ID for the customer’s Google Workspace account. As an account administrator, you can also use the my_customer alias to represent your account’s customer ID. The customer ID can be obtained by the List Users action.

Note: Either the Customer ID or the Domain parameter must be provided.
DomainThe domain name to get users from.

Note: Either the Customer ID or the Domain parameter must be provided.
QueryQuery string for filtering users. For more information on constructing user queries, see Search for Users.

​
Advanced Parameters

ParameterDescription
Delegated User OverridePerform the action on behalf of another user, overriding the delegated user defined in the connection.

If not specified, the delegated user is the one provided in the connection.

Has no effect when using an OAuth connection.

NOTE: the connection details are not edited by this input.
Max ResultsThe maximum number of results to retrieve in a single execution.
Page TokenA page token, received from a previous execution. Provide this to retrieve the subsequent page. When paginating, all other parameters provided must match the execution that provided the page token.

​
Example Output

{
  "kind": string,
  "trigger_event": string,
  "etag": string,
  "users": [
    {
      "id": string,
      "primaryEmail": string,
      "password": value,
      "hashFunction": string,
      "isAdmin": boolean,
      "isDelegatedAdmin": boolean,
      "agreedToTerms": boolean,
      "suspended": boolean,
      "changePasswordAtNextLogin": boolean,
      "ipWhitelisted": boolean,
      "name": {
        {
          "fullName": string,
          "familyName": string,
          "givenName": string,
          "displayName": string
        }
      },
      "kind": string,
      "etag": string,
      "emails": value,
      "externalIds": value,
      "relations": value,
      "aliases": [
        string
      ],
      "isMailboxSetup": boolean,
      "customerId": string,
      "addresses": value,
      "organizations": value,
      "lastLoginTime": string,
      "phones": value,
      "suspensionReason": string,
      "thumbnailPhotoUrl": string,
      "languages": value,
      "posixAccounts": value,
      "creationTime": string,
      "nonEditableAliases": [
        string
      ],
      "sshPublicKeys": value,
      "notes": value,
      "websites": value,
      "locations": value,
      "includeInGlobalAddressList": boolean,
      "keywords": value,
      "deletionTime": string,
      "gender": value,
      "thumbnailPhotoEtag": string,
      "ims": value,
      "customSchemas": value,
      "isEnrolledIn2Sv": boolean,
      "isEnforcedIn2Sv": boolean,
      "archived": boolean,
      "orgUnitPath": string,
      "recoveryEmail": string,
      "recoveryPhone": string
    }
  ],
  "nextPageToken": string
}

​
Workflow Library Example

List Users with Google Admin Console and Send Results Via Email
Workflow LibraryPreview this Workflow on desktop