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

# List users

`GET /api/user_list`

Returns a paginated list of registered users.
Requires `admin`, `advocate`, or the `access_user_info` permission.

## Query parameters

- `include_inactive` 0 | 1
- `next_id` string

## Response `200`

Paginated list of users.

- UserInfoList
  - `next_id` string, nullable, required — Opaque token to pass as `next_id` to retrieve the next page. `null` when no further pages exist.
  - `items` UserInfo[], required
    - `id` integer — Integer user ID.
    - `email` string, email
    - `first_name` string
    - `last_name` string
    - `country` string — Country code (e.g. "US").
    - `subdivisionfirst` string — State.
    - `subdivisionsecond` string — County.
    - `subdivisionthird` string — Municipality.
    - `organization` string
    - `timezone` string — Time-zone string (e.g. "America/New_York").
    - `language` string — Language code (e.g. "en").
    - `privileges` string[] — List of privilege names the user holds.
    - `active` boolean — Whether the user account is active.
    - `account_type` string — Authentication provider type (e.g. "local").

## Other responses

- `403` — Access denied.

---

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