Modern Dashboards API

Franchise dashboards and dashboard types

OpenAPI Specification

modern-dashboards-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: MODERN Partner Dashboards API
  version: v1
  description: Partner API for MODERN (modernis.com), a two-way customer interaction platform for heavy-equipment dealerships. The API lets authorized partners read dashboards, manage service work orders, post events and customer notifications, and maintain technicians and notes on a franchise's behalf. All requests use bearer-token authentication; tokens are obtained by exchanging franchise username/password via HTTP Basic auth against the /token endpoint and are valid for 24 hours, scoped to a single franchise. Every response returns a Modern-Request-Log-ID header used for support.
  contact:
    name: MODERN Support
    url: https://docs.modernis.com/
  x-logo:
    url: https://modernis.com/
servers:
- url: https://connect.modernis.com
  description: Production
security:
- bearerAuth: []
tags:
- name: Dashboards
  description: Franchise dashboards and dashboard types
paths:
  /v1/dashboards:
    get:
      operationId: listDashboards
      tags:
      - Dashboards
      summary: List dashboards
      description: List the franchise's dashboards.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Dashboard'
  /v1/dashboards/types:
    get:
      operationId: listDashboardTypes
      tags:
      - Dashboards
      summary: List dashboard types
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    name:
                      type: string
                      example: field_service
components:
  schemas:
    Dashboard:
      type: object
      properties:
        name:
          type: string
        id:
          type: string
        type:
          type: string
          example: field_service
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: Franchise username/password, used only against /token to obtain a bearer token.
    bearerAuth:
      type: http
      scheme: bearer
      description: 24-hour bearer access token returned by /token; scoped to a single franchise.
x-generated: '2026-07-20'
x-method: derived
x-source: postman/modern-partner-api.postman_collection.json (docs.modernis.com published collection 1530425)