Retrieves a paginated list of either deleted users or all users in a domain.

Basic Parameters

ParameterDescription
Customer IDThe unique ID for the customer’s Google Workspace account. In case
of a multi-domain account, to fetch all groups for a customer, fill this field
instead of domain. You can also use the my_customer alias to represent your
account’s customerId. The customerId is also returned as part of the Users
resource
. Either the customer or the
domain parameter must be provided.
DomainThe domain name. Use this field to get fields from only one domain. To return all domains for a customer account, use the customer query parameter instead. Either the customer or the domain parameter must be provided.
QueryQuery string for searching user fields. 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 ResultsMaximum number of results to return.
Page TokenToken to specify next page in the list.

Example Output

{
	"kind": "<string>",
	"etag": "<string>",
	"users": [
		{
			"kind": "<string>",
			"id": "<string>",
			"etag": "<string>",
			"primaryEmail": "<string>",
			"name": {
				"givenName": "<string>",
				"familyName": "<string>",
				"fullName": "<string>"
			},
			"isAdmin": true,
			"isDelegatedAdmin": true,
			"lastLoginTime": "2021-01-03T17:09:17",
			"creationTime": "2023-10-01T07:23:09",
			"agreedToTerms": false,
			"suspended": true,
			"suspensionReason": "<string>",
			"archived": false,
			"changePasswordAtNextLogin": true,
			"ipWhitelisted": false,
			"emails": [
				{
					"address": "<string>",
					"primary": false
				}
			],
			"relations": [
				{
					"value": "<string>",
					"type": "<string>"
				}
			],
			"organizations": [
				{
					"title": "<string>",
					"type": "<string>",
					"customType": "<string>",
					"department": "<string>",
					"description": "<string>"
				}
			],
			"phones": [
				{
					"value": "<string>",
					"type": "<string>"
				}
			],
			"languages": [
				{
					"languageCode": "<string>",
					"preference": "<string>"
				}
			],
			"nonEditableAliases": [
				"<string>"
			],
			"customerId": "<string>",
			"orgUnitPath": "<string>",
			"isMailboxSetup": false,
			"isEnrolledIn2Sv": true,
			"isEnforcedIn2Sv": true,
			"includeInGlobalAddressList": true,
			"thumbnailPhotoUrl": "<string>",
			"thumbnailPhotoEtag": "<string>"
		}
	]
}

Workflow Library Example

List Users with Google Workspace and Send Results Via Email

Preview this Workflow on desktop