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

# GET /v1/users

`GET /v1/users`

## Request

- The document declares no server URL.
- Auth: none declared

## Query parameters

- `page` integer
- `pageSize` integer
- `email` string
- `keyword` string
- `status` integer

## Response `200`

OK

- GoddessApiV1ListUserReply
  - `items` GoddessApiV1UserItem[]
    - `uid` string
    - `email` string
    - `phone` string
    - `status` integer
    - `createdAt` string
    - `updatedAt` string
    - `name` string
    - `nickname` string
    - `avatar` string
    - `remark` string
  - `total` string
  - `page` integer
  - `pageSize` integer

## Changes

- **2026-03-02** `1426b00d9122`: 1 warning, 2 info
  - removed the optional property `items/items/username` from the response with the `200` status
  - added the optional property `items/items/name` to the response with the `200` status
  - added the optional property `items/items/phone` to the response with the `200` status
- **2026-02-27** `9f425f6d2358`: 2 warning, 1 info
  - removed the optional property `items/items/name` from the response with the `200` status
  - removed the optional property `items/items/phone` from the response with the `200` status
  - added the optional property `items/items/username` to the response with the `200` status

[Operation history](https://skmtc.dev/aide-family/apis/aide-family-goddess-api/changes/v1/users/get.md)

---

[API](https://skmtc.dev/aide-family/apis/aide-family-goddess-api.md) - [All operations](https://skmtc.dev/aide-family/apis/aide-family-goddess-api/llms.txt) - [OpenAPI document](https://skmtc.dev/aide-family/apis/aide-family-goddess-api/revisions/d97780a0ed10?raw)