Chats

List chats for target user (v2, tenant actor)

Auth: Tenant Actor

Returns chat rooms that the specified user belongs to within the target app. Supports User JWT and B2B Server JWT for tenant actors with access to the target app.

get/v2/apps/{appId}/users/{userId}/chats

Request

  • Base URL: https://api.chat.ethora.com
  • URL: https://api.chat.ethora.com/v2/apps/{appId}/users/{userId}/chats
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

appIdstring required

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

userIdstring required

Target User ID, scoped to the appId in the same path.

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.

includeMembersboolean

If true, each returned chat carries a members[] array of member JIDs (and minimal profile info). Default false to keep the list response small for large rooms.

Response 

{
  results: array,
  pagination: { limit: number, offset: number, total: number },
  limit: number,
  offset: number,
  total: number,
  items: array
}
limitinteger required
offsetinteger required
totalinteger required

Changes

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