---
title: "Get all users"
method: GET
path: "/v1/users"
tags: ["Protect User information"]
---

# Get all users

`GET /v1/users`

## Request

- Base URL: `https://api.ui.com/v1/connector/consoles/942A6FF664C0000000000964970E0000000009E710560000000068A9873F:9999999999/proxy/protect/integration`
- URL: `https://api.ui.com/v1/connector/consoles/942A6FF664C0000000000964970E0000000009E710560000000068A9873F:9999999999/proxy/protect/integration/v1/users`
- Auth: none declared
- TypeScript: <https://skmtc.dev/ubiquiti/apis/unifi-protect-api/docs/v1/users/get.ts> (a function with typed inputs; its response is checked against the schema)

Get all Protect users. Users are filtered based on access permissions.

## Response `200`

Success response

- User[]
  - `id` string, required: The primary key of user
  - `name` string, required: The user name (first-name + last-name).
  - `firstName` string, nullable, required: The user first-name.
  - `lastName` string, nullable, required: The user last-name.
  - `email` string, nullable, required: The user email.
  - `ucoreUserId` string, nullable, required: The unique id of the UniFi Identity user. Matches the id field of the corresponding UlpUser.
  - `modelKey` 'user', required: The model key of the user

## Other responses

- `default`: Error response

---

[API](https://skmtc.dev/ubiquiti/apis/unifi-protect-api.md) - [All operations](https://skmtc.dev/ubiquiti/apis/unifi-protect-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ubiquiti/apis/unifi-protect-api/revisions/e341e1381db1?raw)
