> ## Documentation Index
> Fetch the complete documentation index at: https://docs.server.express/llms.txt
> Use this file to discover all available pages before exploring further.

# Dashboard summary

> Counts, the outstanding balance and the five most recent services, invoices and tickets. `outstandingBalance` sums every
UNPAID/OVERDUE invoice converted to GBP; `outstandingBreakdown` gives the unconverted per-currency totals. Open abuse reports
are counted across every service the caller can see, including team services. Unpaid dedicated orders are left out of
recentServices.



## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/client/dashboard
openapi: 3.1.0
info:
  title: Server.Express API
  version: 1.0.0
  description: >-
    The customer-facing Server.Express API: auth, billing, tickets, cloud and
    dedicated servers, hosting, reselling and account management. Every response
    uses the `{ success, data | error }` envelope.
  contact:
    name: Server.Express
    url: https://server.express
servers:
  - url: https://my.server.express/api
    description: Production
security:
  - bearerAuth: []
  - apiToken: []
tags:
  - name: API Tokens
  - name: Account
  - name: Auth
  - name: Cloud
  - name: Coupons
  - name: Credits
  - name: Dashboard
  - name: Dedicated
  - name: Health
  - name: Hosting
  - name: Integrations
  - name: Invoices
  - name: Livechat
  - name: Notifications
  - name: Passkeys
  - name: Payments
  - name: Products
  - name: Public
  - name: Public Invoices
  - name: Public Tools
  - name: Reseller
  - name: SSH Keys
  - name: Services
  - name: Tasks
  - name: Teams
  - name: Tickets
  - name: Web Hosting
  - name: Webhooks
paths:
  /v1/client/dashboard:
    get:
      tags:
        - Dashboard
      summary: Dashboard summary
      description: >-
        Counts, the outstanding balance and the five most recent services,
        invoices and tickets. `outstandingBalance` sums every

        UNPAID/OVERDUE invoice converted to GBP; `outstandingBreakdown` gives
        the unconverted per-currency totals. Open abuse reports

        are counted across every service the caller can see, including team
        services. Unpaid dedicated orders are left out of

        recentServices.
      operationId: publicClientGetDashboard
      responses:
        '200':
          description: Dashboard data.
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                properties:
                  success:
                    type: boolean
                    const: true
                  data:
                    type: object
                    required:
                      - totalServices
                      - activeServices
                      - outstandingBalance
                      - outstandingBreakdown
                      - openTickets
                      - openAbuseReports
                      - recentServices
                      - recentInvoices
                      - recentTickets
                    properties:
                      totalServices:
                        type: integer
                      activeServices:
                        type: integer
                      outstandingBalance:
                        type: integer
                        description: GBP minor units.
                      outstandingBreakdown:
                        type: array
                        items:
                          type: object
                          required:
                            - currency
                            - amount
                          properties:
                            currency:
                              type: string
                            amount:
                              type: integer
                              description: Minor units in that currency.
                      openTickets:
                        type: integer
                        description: Tickets not CLOSED.
                      openAbuseReports:
                        type: integer
                      recentServices:
                        type: array
                        maxItems: 5
                        items:
                          type: object
                          required:
                            - id
                            - name
                            - type
                            - status
                            - nextDueDate
                          properties:
                            id:
                              type: string
                              format: uuid
                            name:
                              type:
                                - string
                                - 'null'
                              description: The service label.
                            type:
                              type: string
                              enum:
                                - DEDICATED
                                - CLOUD
                                - WEB_HOSTING
                                - VPS
                                - CUSTOM
                            status:
                              type: string
                              enum:
                                - ACTIVE
                                - SUSPENDED
                                - TERMINATED
                                - CANCELLED
                                - PENDING
                            nextDueDate:
                              type: string
                              description: >-
                                ISO 8601 timestamp, or an empty string when none
                                is set.
                      recentInvoices:
                        type: array
                        maxItems: 5
                        items:
                          type: object
                          required:
                            - id
                            - number
                            - amount
                            - currency
                            - status
                            - dueDate
                          properties:
                            id:
                              type: string
                              format: uuid
                            number:
                              type: string
                            amount:
                              type: integer
                              description: Total, minor units.
                            currency:
                              type: string
                            status:
                              $ref: '#/components/schemas/PublicClientInvoiceStatus'
                            dueDate:
                              type: string
                              format: date-time
                      recentTickets:
                        type: array
                        maxItems: 5
                        items:
                          type: object
                          required:
                            - id
                            - subject
                            - status
                            - updatedAt
                          properties:
                            id:
                              type: string
                            subject:
                              type: string
                            status:
                              $ref: '#/components/schemas/PublicClientTicketStatus'
                            updatedAt:
                              type: string
                              format: date-time
                              description: Actually the ticket's creation time.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/ServerError'
      security:
        - bearerAuth: []
components:
  schemas:
    PublicClientInvoiceStatus:
      type: string
      description: Lowercased invoice status. Drafts are never shown to customers.
      enum:
        - paid
        - unpaid
        - overdue
        - cancelled
        - refunded
    PublicClientTicketStatus:
      type: string
      description: >-
        Simplified for customers — ANSWERED reads as resolved, CLOSED as closed,
        everything else as open.
      enum:
        - open
        - resolved
        - closed
    ErrorResponse:
      type: object
      required:
        - success
        - error
      properties:
        success:
          type: boolean
          const: false
        error:
          type: string
          description: Human-readable error message.
      additionalProperties: true
  responses:
    Unauthorized:
      description: Missing, invalid or expired credentials.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Forbidden:
      description: >-
        Authenticated but not allowed (missing scope, not an admin, or not your
        resource).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    ServerError:
      description: Unexpected server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Session access token (JWT) from POST /v1/auth/login or /v1/auth/refresh.
        A session satisfies every API scope.
    apiToken:
      type: http
      scheme: bearer
      bearerFormat: se_live_<prefix>_<secret>
      description: >-
        Personal API token created under Settings → API tokens. Only routes
        guarded by verifyApiAuth accept it, and the token must carry the scope
        named in the operation's x-required-scope.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.