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

# List users

`GET /v1/users`

Retrieve existing users.

## Query parameters

- `take` number, nullable
- `skip` number, nullable
- `first_name` string
- `first_name__not` string
- `first_name__isNull` string
- `first_name__isNotNull` string
- `first_name__equals` string
- `first_name__contains` string
- `first_name__startsWith` string
- `first_name__endWith` string
- `last_name` string
- `last_name__not` string
- `last_name__isNull` string
- `last_name__isNotNull` string
- `last_name__equals` string
- `last_name__contains` string
- `last_name__startsWith` string
- `last_name__endWith` string
- `email` string
- `email__not` string
- `email__isNull` string
- `email__isNotNull` string
- `email__equals` string
- `email__contains` string
- `email__startsWith` string
- `email__endWith` string

## Response `200`

- PaginatedUser
  - `meta` object, required
    - `total` number, required — Total of existing items.
    - `taken` number, required — Number of items returned.
    - `skipped` number, required — Number of items skipped.
  - `data` User[], required — List of User.
    - `id` string, required — User ID.
    - `email` string, email, required — User email address.
    - `first_name` string, nullable, required — User first name.
    - `last_name` string, nullable, required — User last name.
    - `picture_url` string, uri, nullable, required — User profile picture URL.
    - `role_id` string, nullable, required — ID of the role assigned to the user.
    - `is_account_owner` boolean, required — Whether the user is the account owner.

---

[API](https://skmtc.dev/hyperline/apis/hyperline-api.md) · [All operations](https://skmtc.dev/hyperline/apis/hyperline-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/hyperline/hyperline-api/revisions/19fa5f22e39b/schema)