Memos unofficial
POST/api/v1/users:batchGet

Get users by username

Lists active users matching the supplied usernames. Provide usernames as an array of strings to identify the users to look up. The response contains the matching user records.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 body field

Request body for looking up active users by username.

usernamesarray<string>optional
The usernames of the active users to retrieve, supplied as an array of strings.

2 status codes
200Returns an object containing a `users` array of matching user records, including each user's role, username, and state.
usersarray<object>optional
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

usernames, when provided, must be an array of strings. The schema does not require the usernames field in the request body.