---
title: "Retrieve one User object by name"
method: GET
path: "/api/users/by_name/{email}/"
tags: ["users"]
---

# Retrieve one User object by name

`GET /api/users/by_name/{email}/`

## Request

- Base URL: `https://docs.blindinsight.io` (the document declares no server; this is the origin it was published from)
- URL: `https://docs.blindinsight.io/api/users/by_name/{email}/`
- Auth: one of:
  - API key in cookie `sessionid`
  - HTTP basic
  - HTTP bearer
- TypeScript: <https://skmtc.dev/blindinsight/apis/blind-insight-rest-api/docs/api/users/by_name/:email/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve a single user by their name (email).

The response will be the user object.

**On the command line:**

```bash
blind users by-name --email "<user-name>"
```

## Path parameters

- `email` string, required

## Response `200`

- User: HyperlinkedModelSerializer with `id` as the first field.
  - `id` string, required
  - `url` string, uri, required
  - `last_login` string, date-time, nullable
  - `is_superuser` boolean: Designates that this user has all permissions without explicitly assigning them.
  - `email` string, email, required
  - `is_staff` boolean: Designates whether the user can log into this admin site.
  - `is_active` boolean: Designates whether this user should be treated as active. Unselect this instead of deleting accounts.
  - `date_joined` string, date-time
  - `first_name` string: First name (optional)
  - `last_name` string: Last name (optional)
  - `settings` object

---

[API](https://skmtc.dev/blindinsight/apis/blind-insight-rest-api.md) - [All operations](https://skmtc.dev/blindinsight/apis/blind-insight-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/blindinsight/apis/blind-insight-rest-api/revisions/0ac902401cea?raw)
