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

# Read order types

> Returns the order types of your organization, newest update first. Requires permission `view/orderType`.
Each row includes the published `trigger` (null until the first publish), `orderStepCount`, `openOrders` (orders not yet final) and `orderCount`.



## OpenAPI

````yaml /openapi/public/openapi-flow.json get /order-types
openapi: 3.0.0
info:
  title: API - Flow
  version: 3.0.0
  description: API Documentation - RESTful API for field operations management.
servers:
  - url: https://apiweb.mile.app/api/v3
security:
  - bearerAuth: []
tags:
  - name: Flow
    description: >-
      Flow is the mobile field application workflow, setting it correctly is
      critical to the success of the field workers in doing their job
      efficiently. Flow attributes consist of IDs, pages, components,
      configurations, and time. The Flow will be used at Task, Automation, or
      Schedule.


      **To see the details of flow object, please follow [this
      link](#tag/flow_model)**
  - name: Automation
    description: >-
      Automation enables you to set up automation based on tasks' events and
      data source's events. It might help you automate creation of tasks, task
      assignment, task placement, task webhook, data source update, datasource
      creation, and data source webhook. Automation attributes consist of IDs,
      automation name, automation type, automation details, and rules.


      **To see the details of automation object, please follow [this
      link](#tag/automation_model)**
  - name: Order Type
    description: >-
      An order type is the blueprint for orders: the list of steps, which task
      type each step uses, and how an order moves from one step to the next.
      Order types are versioned: you edit a draft, validate or simulate it, then
      publish it. These endpoints are served under `/api/v4`.
paths:
  /order-types:
    servers:
      - url: https://apiweb.mile.app/api/v4
    get:
      tags:
        - Order Type
      summary: Read order types
      description: >-
        Returns the order types of your organization, newest update first.
        Requires permission `view/orderType`.

        Each row includes the published `trigger` (null until the first
        publish), `orderStepCount`, `openOrders` (orders not yet final) and
        `orderCount`.
      operationId: getOrderTypes
      parameters:
        - $ref: '#/components/parameters/pageInQuery'
        - name: limit
          in: query
          required: false
          description: Number of rows per page, 1-100. Default `25`.
          schema:
            type: integer
        - name: search
          in: query
          required: false
          description: >-
            Filter by part of the order type name (case-insensitive). Max 100
            characters.
          schema:
            type: string
        - name: state
          in: query
          required: false
          description: >-
            Filter by state: `draft` or `published`. Repeat the parameter to
            pass both.
          schema:
            type: string
            enum:
              - draft
              - published
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: boolean
                    description: Status of response.
                  message:
                    description: Message of API response.
                    type: string
                  data:
                    description: List of order types.
                    type: array
                    items:
                      type: object
                      additionalProperties: true
                example:
                  status: true
                  message: Success
                  data:
                    - _id: 6710a2f4c1d2e3f4a5b6c7d8
                      name: Express Delivery
                      code: EXP
                      state: published
                      publishedVersion: 2
                      hasUnpublishedChanges: false
                      trigger:
                        type: string
                      orderStepCount: 3
                      openOrders: 12
                      orderCount: 40
                      createdTime: '2026-10-01T02:00:00.000+00:00'
                      updatedTime: '2026-10-07T03:15:22.000+00:00'
                      updatedBy: admin@example.com
                  pagination:
                    page: 1
                    limit: 25
                    total: 1
                    totalPages: 1
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: boolean
                    description: Shows if the request was successful.
                  message:
                    type: string
                    description: A short message explaining what went wrong.
                example:
                  status: false
                  message: Bad request - invalid parameters provided.
        '500':
          description: Server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: boolean
                    description: Shows if the request was successful.
                  message:
                    type: string
                    description: A short message explaining what went wrong.
                example:
                  status: false
                  message: Internal server error, please contact support@mile.app.
      deprecated: false
      security:
        - bearerAuth: []
components:
  parameters:
    pageInQuery:
      name: page
      in: query
      schema:
        default: 1
        type: integer
      description: The page number of results to retrieve. **Example:** `2`
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Use a valid Bearer token to authenticate.

````

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