AI Widget

List AI Widget conversations for an app

Returns paginated rows from the chats collection where type='widget' and appId matches. Each row includes resolved visitor identity (joined via user_to_chats -> users where isVisitor:true) so the admin Widget Conversations panel can render visitor handle + first-seen timestamps without an additional round-trip per row.

Auth: tenantActor. Base-app admins acting on a child app via App Switcher reach this endpoint through the same path as other app-scope chat reads.

get/v2/apps/{appId}/widget/conversations

Request

  • Base URL: https://api.chat.ethora.com
  • URL: https://api.chat.ethora.com/v2/apps/{appId}/widget/conversations
  • 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.

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.

Response

{
  results: [
    {
      _id: string,            // Mongo chat _id
      name: string,           // bare room name, "${appId}_<roomUuid>"
      title: string,
      type: 'widget',
      createdAt: ISODate,
      updatedAt: ISODate,
      visitor: {
        _id: string,
        uuid: string,
        xmppUsername: string,
        firstSeenAt: ISODate
      } | null
    }
  ],
  pagination: { limit: number, offset: number, total: number },
  total: number, limit: number, offset: number,
  items: [...same as results...]
}

Changes

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