---
title: "Retrieve one or more User objects, with filters"
method: GET
path: "/api/users/"
tags: ["users"]
---

# Retrieve one or more User objects, with filters

`GET /api/users/`

## 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/`
- 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/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve a list of users. You can filter the list by providing query parameters.
Only users that you have access to will be returned, which in practice means
they are in the same organization.

The response will be a list of user objects.

**On the command line:**

```bash
blind users list
```

## Query parameters

- `date_joined` string, date-time
- `email` string[]
- `first_name` string
- `id` string
- `is_active` boolean
- `is_staff` boolean
- `is_superuser` boolean
- `last_login` string, date-time
- `last_name` string
- `limit` integer
- `offset` integer

## Response `200`

- User[]
  - `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)