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

# Dispatcher Board List

> Retrieve a paginated dispatcher board showing each dispatcher with their assigned drivers and aggregated trip statistics (total miles, gross, driver pay, RPM, trips).



## OpenAPI

````yaml GET /orders/dispatcher-board/list/
openapi: 3.0.1
info:
  title: OpenAPI Datatruck
  description: >-
    To be able to use Datatruck OpenAPI you should create tokens from your
    dashboard. Go to your dashboard and create token with appropriate scopes and
    expiration. Expiration and scopes are optional as well as description for
    your token, but remember name is required.
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://{company}.datatruck.io/api/v1/openapi/
security: []
paths:
  /orders/dispatcher-board/list/:
    get:
      summary: Dispatcher Board List
      description: >-
        Retrieve a paginated dispatcher board showing each dispatcher with their
        assigned drivers and aggregated trip statistics (total miles, gross,
        driver pay, RPM, trips).
      operationId: getDispatcherBoard
      parameters:
        - name: page
          in: query
          required: false
          schema:
            type: integer
            example: 1
          description: Page number for paginated results.
        - name: page_size
          in: query
          required: false
          schema:
            type: integer
            example: 10
            maximum: 25
          description: Number of results per page (max 25, default 10).
      responses:
        '200':
          description: List of dispatcher board retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListDispatcherBoardResponse'
        '400':
          description: Invalid request parameters
components:
  schemas:
    ListDispatcherBoardResponse:
      type: object
      properties:
        count:
          type: integer
          description: Total number of dispatcher board entries.
        next:
          type: string
          nullable: true
          description: URL to the next page of results.
        previous:
          type: string
          nullable: true
          description: URL to the previous page of results.
        results:
          type: array
          items:
            $ref: '#/components/schemas/ListDispatcherBoardResponseItem'
          description: List of dispatcher board entries.
      required:
        - count
        - next
        - previous
        - results
    ListDispatcherBoardResponseItem:
      type: object
      properties:
        dispatcher:
          $ref: '#/components/schemas/ListDispatcherBoardDispatcher'
          nullable: true
          description: Details of the dispatcher, if assigned.
        drivers:
          type: array
          items:
            $ref: '#/components/schemas/ListDispatcherBoardDriver'
          description: List of drivers associated with the dispatcher.
        total_driver_pay:
          type: number
          format: decimal
          maximum: 1000000000000000000
          minimum: -1000000000000000000
          description: Total driver pay for the dispatcher's orders.
        total_gross:
          type: number
          format: decimal
          maximum: 1000000000000000000
          minimum: -1000000000000000000
          description: Total gross amount for the dispatcher's orders.
        total_mile:
          type: number
          format: decimal
          maximum: 1000000000000000000
          minimum: -1000000000000000000
          description: Total miles covered by the dispatcher's orders.
        total_rpm:
          type: number
          format: decimal
          maximum: 1000000000000000000
          minimum: -1000000000000000000
          description: Total revenue per mile for the dispatcher's orders.
        total_trips:
          type: integer
          description: Total number of trips for the dispatcher's orders.
      required:
        - total_driver_pay
        - total_gross
        - total_mile
        - total_rpm
        - total_trips
    ListDispatcherBoardDispatcher:
      type: object
      properties:
        id:
          type: integer
          description: Unique identifier for the dispatcher.
        full_name:
          type: string
          description: Full name of the dispatcher.
      required:
        - id
        - full_name
    ListDispatcherBoardDriver:
      type: object
      properties:
        id:
          type: integer
          description: Unique identifier for the driver.
        full_name:
          type: string
          description: Full name of the driver.
      required:
        - id
        - full_name

````