Virbe Documentation

End Users

Retrieve end user data from your Virbe assistant.

End User Records

End users represent the people who interact with your virtual being. Use these endpoints to retrieve end user records and their associated variables.

List End Users

GET /api/v1/end-users

Retrieve a paginated list of end users.

Query Parameters

  • sortBy – sort order: LastUpdatedDesc or LastUpdatedAsc
  • pageSizeAndNumber[size] – number of results per page
  • pageSizeAndNumber[number] – page number (starting from 1)
curl -X GET \
  "https://my-assistant.virbe.app/api/v1/end-users?sortBy=LastUpdatedDesc&pageSizeAndNumber[size]=10&pageSizeAndNumber[number]=1" \
  -H "x-virbe-api-key: YOUR_API_KEY"

On this page