Method: users.list Stay organized with collections Save and categorize content based on your preferences.
Retrieves a paginated list of either deleted users or all users in a domain.
HTTP request
GET https://admin.googleapis.com/admin/directory/v1/users
The URL usesgRPC Transcoding syntax.
Query parameters
| Parameters | |
|---|---|
customFieldMask |
A comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when |
customer |
The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all users for a customer, use this field instead of |
domain |
The domain name. Use this field to get users from only one domain. To return all domains for a customer account, use the |
event |
Event on which subscription is intended (if subscribing) |
maxResults |
Maximum number of results to return. |
orderBy |
Property to use for sorting results. |
pageToken |
Token to specify next page in the list. The page token is only valid for three days. |
projection |
What subset of fields to fetch for this user. |
query |
Query string for searching user fields. For more information on constructing user queries, seeSearch for Users. |
showDeleted |
If set to |
sortOrder |
Whether to return results in ascending or descending order, ignoring case. |
viewType |
Whether to fetch the administrator-only or domain-wide public view of the user. For more information, seeRetrieve a user as a non-administrator. |
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
| JSON representation |
|---|
{"kind":string,"trigger_event":string,"etag":string,"users":[{object ( |
| Fields | |
|---|---|
kind |
Kind of resource this is. |
trigger_event |
Event that triggered this response (only used in case of Push Response) |
etag |
ETag of the resource. |
users[] |
A list of user objects. |
nextPageToken |
Token used to access next page of this result. The page token is only valid for three days. |
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/admin.directory.userhttps://www.googleapis.com/auth/admin.directory.user.readonlyhttps://www.googleapis.com/auth/cloud-platform
For more information, see theAuthorization guide.
Event
Type of the Subscription event
| Enums | |
|---|---|
ADD | User Created Event |
DELETE | User Deleted Event |
MAKE_ADMIN | User Admin Status Change Event |
UNDELETE | User Undeleted Event |
UPDATE | User Updated Event |
OrderBy
| Enums | |
|---|---|
EMAIL | Primary email of the user. |
FAMILY_NAME | User's family name. |
GIVEN_NAME | User's given name. |
Projection
| Enums | |
|---|---|
BASIC | Do not include any custom fields for the user. |
CUSTOM | Include custom fields from schemas requested incustomFieldMask. |
FULL | Include all fields associated with this user. |
SortOrder
| Enums | |
|---|---|
ASCENDING | Ascending order. |
DESCENDING | Descending order. |
ViewType
| Enums | |
|---|---|
admin_view | Results include both administrator-only and domain-public fields for the user. |
domain_public | Results only include fields for the user that are publicly visible to other users in the domain. |
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-25 UTC.