Omnix

UserDashboardRpc

This RPC class provides dashboard-oriented read endpoints for the current user’s conversations, tickets, and calendar events. The methods delegate to underlying services and return paginated or filtered data for display in user-facing dashboard views.

Endpoints

POST /api/rpc (Method: UserDashboardRpc.getMyOpenConversations)

This method returns open or pending conversations assigned to the current user. It passes a filter to UnifiedInboxService that targets the current user via the special assigneeId: 'self' value.

  • Description: Gets open conversations assigned to the current user.

  • Request Body:

    {"method": "UserDashboardRpc.getMyOpenConversations","params": {}}
  • Parameters:

    NameTypeRequiredDescriptionparamsObjectNoThis method accepts an empty object.

  • Response:

    {"success": true,"data": {
        "data": [
          {
            "...": "Conversation records returned by `UnifiedInboxService.getConversations`"
          }
        ],
        "totalCount": 0}}
  • Example (cURL):

    curl -X POST "${APP_BASE_URL}/api/rpc" \
      -H "Content-Type: application/json" \
      -d '{
        "method": "UserDashboardRpc.getMyOpenConversations",
        "params": {}
      }'

POST /api/rpc (Method: UserDashboardRpc.getMyOpenTickets)

This method returns tickets assigned to the current user. It passes a filter to TicketService that selects tickets with assigneeId: 'self' and statuses new or open.

  • Description: Gets open tickets assigned to the current user.

  • Request Body:

    {"method": "UserDashboardRpc.getMyOpenTickets","params": {}}
  • Parameters:

    NameTypeRequiredDescriptionparamsObjectNoThis method accepts an empty object.

  • Response:

    {"success": true,"data": {
        "data": [
          {
            "...": "Ticket records returned by `TicketService.getTickets`"
          }
        ],
        "totalCount": 0}}
  • Example (cURL):

    curl -X POST "${APP_BASE_URL}/api/rpc" \
      -H "Content-Type: application/json" \
      -d '{
        "method": "UserDashboardRpc.getMyOpenTickets",
        "params": {}
      }'

POST /api/rpc (Method: UserDashboardRpc.getMyUpcomingAppointments)

This method returns calendar events for the authenticated user within the requested time range. The request must include RFC 3339 datetime strings for both start and end.

  • Description: Gets upcoming calendar events for the current user.

  • Request Body:

    {"method": "UserDashboardRpc.getMyUpcomingAppointments","params": {
        "start": "2026-05-29T09:00:00.000Z",
        "end": "2026-05-29T17:00:00.000Z"}}
  • Parameters:

    NameTypeRequiredDescriptionstartStringYesDatetime string with an explicit offset.endStringYesDatetime string with an explicit offset.

  • Response:

    {"success": true,"data": [
        {
          "...": "Calendar events returned by `CalendarService.getEventsForRange`"
        }]}
  • Example (cURL):

    curl -X POST "${APP_BASE_URL}/api/rpc" \
      -H "Content-Type: application/json" \
      -d '{
        "method": "UserDashboardRpc.getMyUpcomingAppointments",
        "params": {
          "start": "2026-05-29T09:00:00.000Z",
          "end": "2026-05-29T17:00:00.000Z"
        }
      }'