GET
/api/v1/usersList users
Lists users on the instance, with optional filtering and inclusion of deleted users. Use pageToken to continue through results; pageSize defaults to at most 50 and values above 1000 are coerced to 1000.
pageSizeintegeroptional
Maximum number of users to return; the service may return fewer. Defaults to at most 50 when omitted, and values above 1000 are coerced to 1000.
pageTokenstringoptional
A token from a previous response to retrieve the next page of users.
filterstringoptional
Filter expression for user results; supports `username` with the `==` operator, for example `username == 'steven'`.
showDeletedbooleanoptional
Whether to include deleted users in the results.
200Returns a list of users and a `nextPageToken` when another page is available.
usersarray<object>optional
The list of users.
nextPageTokenstringoptional
A token that can be sent as `page_token` to retrieve the next page.
If this field is omitted, there are no subsequent pages.
defaultDefault error response
codeintegeroptional
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
messagestringoptional
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
detailsarray<object>optional
A list of messages that carry the error details. There is a common set of message types for APIs to use.
Error handling
pageSize values above 1000 are coerced to 1000, and the default is at most 50 users. If you use filter, the supported field is username and the supported operator is ==; showDeleted controls whether deleted users are included.