---
title: "Retrieve user information by username"
method: GET
path: "/api/user_info"
tags: ["Users"]
---

# Retrieve user information by username

`GET /api/user_info`

Returns information about the user with the given e-mail address.
Requires `admin`, `advocate`, or the `access_user_info` permission.

## Query parameters

- `username` string, email, required
- `case_sensitive` 0 | 1

## Response `200`

User information.

- UserInfo — Information about a docassemble user.
  - `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

- `400` — Bad request.
- `403` — Access denied.
- `404` — User not found.

---

[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)
