---
title: "List Users"
method: GET
path: "/v3/users"
tags: ["Users"]
---

# List Users

`GET /v3/users`

Returns a paginated list of user objects.

## Query parameters

- `page[size]` integer
- `page[number]` integer
- `filter` object
  - `id` StringFieldEqualsFilter — Filters on the given string field value by exact match.
    - `eq` string
  - `email` LegacyStringFieldFilter — Filter using **one** of the following operators: `eq`, `contains`
    - `eq` string — The field exactly matches the provided value.
    - `contains` string — The field contains the provided value.
  - `full_name` LegacyStringFieldFilter — Filter using **one** of the following operators: `eq`, `contains`
    - `eq` string — The field exactly matches the provided value.
    - `contains` string — The field contains the provided value.
  - `active` boolean — Filter by a boolean value (true/false).

## Response `200`

A paginated list response for a collection of users.

- object
  - `meta` PaginatedMeta — returns the pagination information
    - `page` PageMeta, required — Contains pagination query parameters and the total number of objects returned.
      - `number` number, required
      - `size` number, required
      - `total` number, required
  - `data` User[]
    - `id` string, uuid — The User ID.
    - `email` string, email — The email registered to the user.
    - `full_name` string — The User's full name.
    - `preferred_name` string — The User's preferred name.
    - `active` boolean — Returns True if a user has verified their email address.
    - `inferred_region` string — The Konnect region closest to the user's IP address. This property might only be set for users on signup through Konnect’s build-in native authentication.
    - `created_at` string, date-time — The time stamp for the date the account was registered.
    - `updated_at` string, date-time — A Unix timestamp representation of the most recent change to the User account.

## Other responses

- `400` — Bad Request

---

[API](https://skmtc.net/kong/apis/konnect-api-go-sdk.md) · [All operations](https://skmtc.net/kong/apis/konnect-api-go-sdk/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kong/konnect-api-go-sdk/versions/0261aef4b1e2/schema)