Chats

Get users / chat members

Deprecated: use /v2/chats/users instead.

Auth: User JWT

Returns users in the current app, or chat members when chatName is provided. If xmppUsername is provided, returns a single user record.

get/v1/chats/users

Request

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

Query parameters

chatNamestring

Internal chat name in the form <appId>_<chatId>. Returned by every chat-listing endpoint as chats[].name.

xmppUsernamestring

Filter results to a specific member's JID. When set, the response contains only the row(s) for that user across the listed chats.

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.

Response

{ result?: object, results?: array }

Changes

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