---
title: "List users"
method: GET
path: "/v1/users"
tags: ["users"]
---

# List users

`GET /v1/users`

## Request

- Base URL: `https://api.brixsignage.com`
- URL: `https://api.brixsignage.com/v1/users`
- Auth: HTTP bearer

Returns the workspace roster: each person's role, which locations they can access, their sign-in method, two-factor authentication status, and last login.

**Notes.**
- Not paginated. Deleted (erased) people are not listed. A caller whose access is limited to some locations sees only the people with access there, and only those locations in `access`.

## Response `200`

Success.

- object
  - `data` User[], required
    - `id` string, required
    - `name` string, required
    - `email` string, required
    - `status` 'active' | 'invited' | 'deactivated', required: `invited` until the person sets a password or signs in.
    - `roleId` string, nullable, required: The role of the first entry in `access`; null when the person has no access.
    - `scope` string, required: The location name of the first entry in `access`; `—` when none.
    - `loginMethod` 'sso' | 'passkey' | 'password', required: How the person signs in.
    - `totpEnabled` boolean, required: Two-factor authentication with an authenticator app is on.
    - `passkeyCount` integer, required
    - `lastLoginAt` string, nullable, required: ISO-8601 timestamp (UTC).
    - `access` object[], required: Each location the person can access and the role they hold there. Only locations the caller can see are listed.
      - `nodeId` string, required: Location id.
      - `nodeName` string, required: Location name; `—` when the location no longer exists.
      - `roleId` string, required
      - `roleName` string, required: Role name; `—` when the role no longer exists.

## Other responses

- `401`: Missing, expired or revoked bearer token.
- `403`: The token lacks the permission this operation needs (see `x-brix-permission`).
- `5XX`: Server error. The body carries a `requestId` to quote to support.

---

[API](https://skmtc.dev/brixsignage/apis/brix-api.md) · [All operations](https://skmtc.dev/brixsignage/apis/brix-api/llms.txt) · [OpenAPI document](https://skmtc.dev/brixsignage/apis/brix-api/revisions/02fd3665dc7d?raw)