---
title: "List users in app"
method: GET
path: "/v1/users/{appId}"
tags: ["Users"]
---

# List users in app

`GET /v1/users/{appId}`

## Request

- Base URL: `https://api.chat.ethora.com`
- URL: `https://api.chat.ethora.com/v1/users/{appId}`
- Auth: HTTP bearer

**Auth**: User JWT

get users

## Path parameters

- `appId` string, required

## Query parameters

- `limit` integer
- `offset` integer
- `orderBy` 'email' | 'createdAt' | 'firstName' | 'lastName' | 'authMethod' | 'mfaEnabled' | 'tags' | 'role'
- `order` 'asc' | 'desc'
- `status` 'archived'
- `includeArchived` boolean
- `access` 'admin'
- `tag` string

## Response `200`

Paged list. Each item is the user's public record plus `acl` (the
user's permission row for this app, when any), `role`
(`superadmin` | `owner` | `admin` | `member`), `mfaEnabled` and
`lastSeen`. Credentials (password hash, temporary password, XMPP
password, verification tokens, MFA secrets) are never included.
```
{ items: [...], total, limit, offset, orderBy, order,
  ownerUserId, access: 'all'|'admin', tag: string|null }
```

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `422`: ``` { error: string } ```
- `500`: Internal Server Error

---

[API](https://skmtc.dev/ethora/apis/platform-api.md) · [All operations](https://skmtc.dev/ethora/apis/platform-api/llms.txt) · [OpenAPI document](https://skmtc.dev/ethora/apis/platform-api/revisions/01b6e64378ee?raw)