---
title: "GET /api/v1/users"
method: GET
path: "/api/v1/users"
tags: ["UserService"]
---

# GET /api/v1/users

`GET /api/v1/users`

ListUsers returns a list of users.

## Query parameters

- `pageSize` integer
- `pageToken` string
- `filter` string
- `showDeleted` boolean

## Response `200`

OK

- ListUsersResponse
  - `users` User[] — The list of users.
    - `name` string — The resource name of the user. Format: users/{user}
    - `role` 'ROLE_UNSPECIFIED' | 'ADMIN' | 'USER', enum, required — The role of the user.
    - `username` string, required — Required. The unique username for login.
    - `email` string — Optional. The email address of the user.
    - `displayName` string — Optional. The display name of the user.
    - `avatarUrl` string — Optional. The avatar URL of the user.
    - `description` string — Optional. The description of the user.
    - `password` string — Input only. The password for the user.
    - `state` 'STATE_UNSPECIFIED' | 'NORMAL' | 'ARCHIVED', enum, required — The state of the user.
    - `createTime` string, date-time — Output only. The creation timestamp.
    - `updateTime` string, date-time — Output only. The last update timestamp.
  - `nextPageToken` string — A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.

## Other responses

- `default` — Default error response

---

[API](https://skmtc.net/usememos/apis/untitled-api.md) · [All operations](https://skmtc.net/usememos/apis/untitled-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/usememos/untitled-api/versions/f01e84cf5acc/schema)