Get users / chat members (v2)
Auth: User JWT
Returns users in the current app, or chat members when chatName is provided. If xmppUsername or userId is provided, returns a single user record. Parameters should be sent in the query string for GET requests. Pagination uses limit and offset, where offset is the number of records to skip. xmppUsername is the preferred identifier for single-user lookup. userId is a backward-compatible identifier matched against Ethora user uuid and Mongo _id.
Request
- Base URL: https://api.chat.ethora.com
- URL: https://api.chat.ethora.com/v2/chats/users
- Auth: HTTP bearer
Query parameters
Internal chat name in the form <appId>_<chatId>. Returned by every chat-listing endpoint as chats[].name.
Filter results to a specific member's JID. When set, the response contains only the row(s) for that user across the listed chats.
Target User ID, scoped to the appId in the same path.
Maximum number of items to return per page. Server caps vary per endpoint; the response carries the actual page size.
Number of items to skip from the beginning of the result set. Use with limit for paging.
Response
// list response:
{ limit, offset, total, items, results, pagination, success }
// single response (when xmppUsername/userId provided):
{ result, success }
Changes
No recorded changes to this operation across all 1 revision of this API.