Virbe Documentation

List Conversations

Retrieve a paginated list of conversations, optionally filtered by profile or end user.

GET /api/v1/conversations-history

Retrieve a list of conversations, optionally filtered by profile or end user.

Query Parameters

  • profileId – filter by profile ID (UUID). Use this to find conversations from a specific kiosk or web widget.
  • endUserId – filter by end user ID (UUID)
  • sortBy – sort order: CreatedAtDesc or CreatedAtAsc
  • state – filter by conversation state (e.g. Active, Closed)
  • pageSizeAndNumber[size] – number of results per page
  • pageSizeAndNumber[number] – page number (starting from 1)
  • includeProfile – set to true to include profile data in the response
  • includeVariables – set to true to include conversation variables
curl -X GET \
  "https://my-assistant.virbe.app/api/v1/conversations-history?profileId=PROFILE_ID&sortBy=CreatedAtDesc&pageSizeAndNumber[size]=1&pageSizeAndNumber[number]=1" \
  -H "x-virbe-api-key: YOUR_API_KEY"

On this page