> ## Documentation Index
> Fetch the complete documentation index at: https://docs.blinkops.com/llms.txt
> Use this file to discover all available pages before exploring further.
# List Users
Retrieve a list of all users given a `Customer ID` or a `Domain`.
External Documentation
To learn more, visit the [Google Admin Console documentation](https://developers.google.com/workspace/admin/directory/reference/rest/v1/users/list).
## Basic Parameters
| Parameter | Description |
| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Customer ID | The 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. |
| Domain | The domain name to get users from.
**Note**: Either the `Customer ID` or the `Domain` parameter must be provided. |
| Query | Query string for filtering users. For more information on constructing user queries, see [Search for Users](https://developers.google.com/admin-sdk/directory/v1/guides/search-users). |
| Return All Pages | Automatically fetch all resources, page by page. |
## Advanced Parameters
| Parameter | Description |
| ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Delegated User Override | Perform 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 Results | The maximum number of results to retrieve in a single execution. |
| Page Token | A 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
```json theme={"dark"}
{
"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](https://library.blinkops.com/workflows/list-users-with-google-admin-console-and-send-results-via-email)
Preview this Workflow on desktop