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

# List Users

`GET /api/v1/users/`

List the existing users.

## Query parameters

- `page` integer, nullable — The page number from which to start (0-based)
- `limit` integer — The maximum number of items to return
- `search_fields` UserProperties[] — String names of fields to search. Correspond by index to search field values
- `search_field_values` string[] — Values of fields to search. Correspond by index to search fields. Unless field name contains "list", an individual search field value cannot be a list
- `order_by` 'email' | 'first_name' | 'last_name' | 'role_id' | 'role_name' | 'email_first_name_last_name' | 'activity_status' | 'last_updated' — Names of user fields supported for filtering/sorting on list endpoint.
- `order_by_direction` 'asc' | 'desc' — The direction in which to order list results, either ascending or descending.
- `fields` UserProperties[], nullable — The fields to include in the response
- `start_datetime` string, nullable — The start datetime for filtering results
- `end_datetime` string, nullable — The end datetime for filtering results

## Response `200`

Successful Response

- ListResponseUserResponse
  - `items` UserResponse[], required — List of items returned from the query
    - `email` string, required — Email address of the user
    - `first_name` string, nullable — First name of the user
    - `last_name` string, nullable — Last name of the user
    - `role_id` integer, required — ID of the role assigned to the user
    - `utm` DaoUtm
      - `utm_source` string, nullable
      - `utm_medium` string, nullable
      - `utm_campaign` string, nullable
      - `utm_term` string, nullable
      - `utm_content` string, nullable
    - `last_updated_comments` string, nullable — Comments for the most recent edit to the user.
    - `id` integer, required — Internal ID of the user
    - `role_name` string, required — Name of the role assigned to the user
    - `email_sent` boolean, required — Whether the welcome email has been sent to the user
    - `activity_status` 'not_invited' | 'invited' | 'active', required
    - `last_updated` string, date-time, required — The timestamp of the most recent update to the user
    - `last_updated_by` string, nullable — The email address of the user who last updated the user
    - `last_session_at` string, date-time, nullable — The timestamp of the user's last session
  - `page` integer, required — The page number of the results (0-based)
  - `page_size` integer, required — The number of items returned per page
  - `total_pages` integer, nullable — The total number of pages of results given the indicated page size
  - `total_count` integer, nullable — The total number of items returned from the query

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/asksyllable/apis/syllablesdk.md) · [All operations](https://skmtc.net/asksyllable/apis/syllablesdk/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/asksyllable/syllablesdk/revisions/534f1f22c775/schema)