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

# Read briefs

> Returns the briefs of your organization, newest update first. Used by the web Brief page and by the mobile app.
No permission is needed to call it; the list is filtered for the caller: The owner role sees every brief. Every other role, admins included and whatever Brief permissions it has, sees the briefs shared with their own role plus the briefs shared with every role (empty `roleIds`).



## OpenAPI

````yaml /openapi/public/openapi-flow.json get /briefs
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 flow
      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`.
  - name: Brief
    description: >-
      A brief is a reference PDF, such as an SOP, a product guide or a campaign
      brief, that your field team reads in the mobile app. It comes from an
      https link or an uploaded PDF, and it is shared with chosen roles or with
      every role. These endpoints are served under `/api/v4`.
paths:
  /briefs:
    servers:
      - url: https://apiweb.mile.app/api/v4
    get:
      tags:
        - Brief
      summary: Read briefs
      description: >-
        Returns the briefs of your organization, newest update first. Used by
        the web Brief page and by the mobile app.

        No permission is needed to call it; the list is filtered for the caller:
        The owner role sees every brief. Every other role, admins included and
        whatever Brief permissions it has, sees the briefs shared with their own
        role plus the briefs shared with every role (empty `roleIds`).
      operationId: getBriefs
      parameters:
        - name: search
          in: query
          required: false
          description: |-
            Filter by part of the brief name (case-insensitive).
            **Example**: `sop`
          schema:
            type: string
        - $ref: '#/components/parameters/pageInQuery'
        - name: limit
          in: query
          required: false
          description: Number of rows per page, 1-100. Default `20`.
          schema:
            type: integer
      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: Paginated list of briefs.
                    type: object
                    additionalProperties: true
                example:
                  status: true
                  message: Success.
                  data:
                    current_page: 1
                    data:
                      - _id: 6738a1f2c4e9b10012ab34cd
                        name: SOP Servis Berkala 10.000 km
                        type: string
                        sourceType: upload
                        url: >-
                          https://storage.example.com/production/5f1a2b3c4d5e6f7081920a1b/brief/2026/11/16/1763270400_sop-servis-berkala.pdf
                        fileName: sop-servis-berkala.pdf
                        fileSize: 2483112
                        roleIds:
                          - 64b0c1d2e3f4a5b6c7d8e9f0
                          - 64b0c1d2e3f4a5b6c7d8e9f1
                        roles:
                          - _id: 64b0c1d2e3f4a5b6c7d8e9f0
                            name: Mekanik
                          - _id: 64b0c1d2e3f4a5b6c7d8e9f1
                            name: Service Advisor
                        createdBy: admin@artaboga.example
                        updatedBy: admin@artaboga.example
                        createdTime: '2026-11-16T03:20:00.000000Z'
                        updatedTime: '2026-11-16T03:20:00.000000Z'
                      - _id: 6738a20bc4e9b10012ab34ce
                        name: Panduan Oli Mesin 2026
                        type: string
                        sourceType: link
                        url: https://docs.example.com/oli-mesin-2026.pdf
                        fileName: null
                        fileSize: null
                        roleIds: []
                        roles: []
                        createdBy: admin@artaboga.example
                        updatedBy: admin@artaboga.example
                        createdTime: '2026-11-15T08:02:11.000000Z'
                        updatedTime: '2026-11-15T08:02:11.000000Z'
                    first_page_url: https://apiweb.mile.app/api/v4/briefs?page=1
                    from: 1
                    last_page: 1
                    last_page_url: https://apiweb.mile.app/api/v4/briefs?page=1
                    next_page_url: null
                    path: https://apiweb.mile.app/api/v4/briefs
                    per_page: 20
                    prev_page_url: null
                    to: 2
                    total: 2
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: boolean
                    description: Status of response.
                  message:
                    description: Message of API response.
                    type: string
                  data:
                    description: Always null on error.
                    type: object
                    additionalProperties: true
                  failedCode:
                    description: Error code, see the descriptions above.
                    type: string
                example:
                  status: false
                  message: The limit field must not be greater than 100.
                  data: null
                  failedCode: brief-009
        '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.