POST/your-webhook-url?action=users.list

List users

pageSize
int32
Required
The maximum number of users to return. The webhook is allowed to return fewer than this value, but it should never return more.
pageToken
string
A page token, this is from the response of the previous list request.
This should be used to determine the next page of results.

users
CustomUser[]
The list of users.
id
string
The external identifier for the user.
displayName
string
The human-readable display name of the user.
The maximum length is 200 characters.
email
string
The email address of the user.
The maximum length is 320 characters.
emailVerified
boolean
Whether the user's email address has been verified.
phoneNumber
string
The E164 phone number for the user (e.g. +12125550123).
phoneNumberVerified
boolean
Whether the user's phone number has been verified.
imageUrl
string
The photo/avatar URL of the user.
The maximum length is 2000 characters.
disabled
boolean
Whether the user is disabled.
nextPageToken
string
A token the webhook can set to indicate it has more results.
This can be a page number, offset number, timestamp, or any value the webhook handler wants to use for pagination.
It must be encoded as a string.

code
enum
The general error code (e.g. INVALID_ARGUMENT).
Possible values:
OKCANCELLEDUNKNOWNINVALID_ARGUMENTDEADLINE_EXCEEDEDNOT_FOUNDALREADY_EXISTSPERMISSION_DENIEDUNAUTHENTICATEDRESOURCE_EXHAUSTEDFAILED_PRECONDITIONABORTEDOUT_OF_RANGEUNIMPLEMENTEDINTERNALUNAVAILABLEDATA_LOSS
message
string
A developer-facing error message.
reason
string
A reason code for the error (e.g. USER_PENDING_DELETION).
param
string
The parameter path related to the error (e.g. member.userId).
metadata
string
Additional metadata related to the error.
localeMessage
string
A user-facing error message.