Users

List users in app

Auth: User JWT

get users

get/v1/users/{appId}

Request

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

Path parameters

appIdstring required

Target App ID. Must be an app the calling actor owns or has been delegated access to.

Query parameters

limitinteger

Maximum number of items to return per page. Server caps vary per endpoint; the response carries the actual page size.

offsetinteger

Number of items to skip from the beginning of the result set. Use with limit for paging.

orderBy'email' | 'createdAt' | 'firstName' | 'lastName' | 'authMethod' | 'mfaEnabled' | 'tags' | 'role'

Field to sort by (default createdAt). mfaEnabled sorts on the user's two-step verification status; authMethod on the sign-in provider recorded at the last login (legacy users with none sort first); tags puts users without tags first (asc) or tagged users first (desc); role orders members < admins < owner < super admins (asc) or the reverse (desc). Ties are broken by _id so paging is stable.

order'asc' | 'desc'

Sort direction: asc (default) or desc.

status'archived'

archived lists only archived users (restore view).

includeArchivedboolean

Include archived users alongside active ones.

access'admin'

admin lists only users who can manage this app in the admin panel: any permission over settings, users, tokens, push or stats, the app owner, and platform super admins. The "may create apps" grant every base-app signup receives does not count.

tagstring

Only users carrying this tag (case-insensitive, surrounding whitespace ignored). See GET /v1/users/tags/{appId} for the tags in use.

Response

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 }

Changes

No recorded changes to this operation across all 1 revision of this API.