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

# Get Export Resource

> Returns an export resource.



## OpenAPI

````yaml /api-reference/ops/openapi.json get /api/v1/ops/export-resources/{resource}
openapi: 3.0.0
info:
  title: DEVMOB OPS API
  description: DEVMOB API
  version: '1.0'
  contact: {}
servers: []
security: []
tags:
  - name: Auth
    description: Authentication and token lifecycle
  - name: Bank Account
    description: Bank accounts
  - name: Benefit
    description: Benefit categories and usage history
  - name: Benefit Program
    description: Fare benefit programs
  - name: Benefit Request
    description: Fare benefit requests and documents
  - name: Credit Grant
    description: Company granted credits
  - name: Driver
    description: Company drivers
  - name: Employee
    description: Company employees
  - name: Employee Session
    description: Employee sessions
  - name: Export
    description: Export resources
  - name: Export Job
    description: Immediate export jobs
  - name: Export Schedule
    description: Scheduled exports
  - name: Invite
    description: Member invitations
  - name: Notification
    description: OPS inbox notifications
  - name: Offering
    description: Trip offerings and seat maps
  - name: Order
    description: Orders
  - name: Organization
    description: Organization profile
  - name: Organization Address
    description: Organization address
  - name: OTP
    description: One-time password flows
  - name: Payment
    description: Payments
  - name: Permission
    description: Permissions
  - name: Point
    description: Point lookup
  - name: Profile
    description: Authenticated OPS profile
  - name: Promotion
    description: Promotions
  - name: Promotion Rule
    description: Promotion rules
  - name: Receivable
    description: Receivables
  - name: Report
    description: Operational reports
  - name: Role
    description: Roles
  - name: Route
    description: Routes
  - name: Route Approval
    description: Route approvals
  - name: Routing
    description: Routing helpers
  - name: Storage
    description: Storage uploads
  - name: Support
    description: Support cases
  - name: Transfer
    description: Transfers
  - name: Trip
    description: Trips
  - name: Trip Event
    description: Trip operational events
  - name: Trip Schedule
    description: Recurring trip schedules
  - name: Trip Tracking
    description: Trip GPS tracking
  - name: Vehicle
    description: Vehicles and seats
paths:
  /api/v1/ops/export-resources/{resource}:
    get:
      tags:
        - Export
      summary: Get Export Resource
      description: Returns an export resource.
      operationId: getExportResource
      parameters:
        - name: resource
          required: true
          in: path
          schema:
            type: string
            description: Export resource key
            example: order
        - name: fields
          required: false
          in: query
          description: >-
            Comma-separated list of fields to include in the response. Supports
            dot notation for nested projection (e.g.
            `id,name,user.email,trips.route.id`). Unknown fields are silently
            dropped.
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExportResource'
        '400':
          content:
            application/json:
              example:
                errors:
                  - message: required
                    path: name
                message: Bad Request Error
                statusCode: 400
              schema:
                properties:
                  message:
                    type: string
                  statusCode:
                    enum:
                      - 400
                    type: number
                  errors:
                    items:
                      properties:
                        message:
                          type: string
                        path:
                          type: string
                      required:
                        - message
                        - path
                      type: object
                    type: array
                required:
                  - message
                  - statusCode
                type: object
          description: Bad Request Error
        '401':
          content:
            application/json:
              example:
                message: Missing or invalid access token
                statusCode: 401
              schema:
                properties:
                  message:
                    type: string
                  statusCode:
                    enum:
                      - 401
                    type: number
                required:
                  - message
                  - statusCode
                type: object
          description: Unauthorized
        '403':
          content:
            application/json:
              example:
                message: Insufficient permissions
                statusCode: 403
              schema:
                properties:
                  message:
                    type: string
                  statusCode:
                    enum:
                      - 403
                    type: number
                required:
                  - message
                  - statusCode
                type: object
          description: Forbidden
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  statusCode:
                    type: number
                    enum:
                      - 404
                required:
                  - message
                  - statusCode
              example:
                message: Resource not found
                statusCode: 404
        '500':
          content:
            application/json:
              example:
                message: Internal Server Error
                statusCode: 500
              schema:
                properties:
                  message:
                    type: string
                  statusCode:
                    enum:
                      - 500
                    type: number
                required:
                  - message
                  - statusCode
                type: object
          description: Internal Server Error
      security:
        - bearer: []
        - bearer: []
components:
  schemas:
    ExportResource:
      type: object
      properties:
        exportResourceId:
          type: string
          format: uuid
          description: Identificador único
        resource:
          type: string
          description: >-
            Chave estável do recurso exportável, como `order`, `ticket`,
            `vehicle` ou `trip`
        label:
          type: string
          description: Nome exibido para o usuário no fluxo de exportação
        description:
          type: string
          nullable: true
          description: Descrição curta do recurso exportável
        permission:
          type: string
          description: Permission necessária para exportar o recurso
        formats:
          type: array
          items:
            type: string
            enum:
              - CSV
              - XLSX
          description: Formatos disponíveis para geração
        defaultFormat:
          type: string
          enum:
            - CSV
            - XLSX
          description: Formato pré-selecionado
        defaultColumns:
          type: array
          items:
            type: string
          description: Colunas selecionadas por padrão
        columns:
          type: array
          items:
            $ref: '#/components/schemas/ExportColumn'
          description: Colunas permitidas para exportação
        filters:
          type: array
          items:
            $ref: '#/components/schemas/ExportFilter'
          description: Filtros permitidos para consulta
        maxRows:
          type: integer
          nullable: true
          description: Limite máximo de linhas por exportação
        status:
          type: string
          enum:
            - ACTIVE
            - INACTIVE
          description: Status do catálogo
        createdAt:
          type: string
          format: date-time
          description: Data de criação
        updatedAt:
          type: string
          format: date-time
          description: Data da última atualização
        deletedAt:
          type: string
          format: date-time
          nullable: true
          description: Data de remoção lógica
      required:
        - exportResourceId
        - resource
        - label
        - description
        - permission
        - formats
        - defaultFormat
        - defaultColumns
        - columns
        - filters
        - maxRows
        - status
        - createdAt
        - updatedAt
        - deletedAt
      description: Catálogo de recursos exportáveis, colunas e filtros permitidos
    ExportColumn:
      type: object
      properties:
        field:
          type: string
          description: Chave da coluna no arquivo
        label:
          type: string
          description: Nome exibido para a coluna
        type:
          type: string
          enum:
            - STRING
            - NUMBER
            - DATE
            - BOOLEAN
            - ENUM
          description: Tipo do valor usado para formatação
        values:
          type: array
          items:
            type: string
          nullable: true
          description: Valores possíveis quando `type` for `ENUM`
        sensitive:
          type: boolean
          nullable: true
          description: Indica coluna sensível que pode exigir permission adicional
      required:
        - field
        - label
        - type
        - values
        - sensitive
      description: ExportColumn
    ExportFilter:
      type: object
      properties:
        field:
          type: string
          description: Campo filtrável
        label:
          type: string
          description: Nome exibido para o filtro
        type:
          type: string
          enum:
            - STRING
            - NUMBER
            - DATE
            - BOOLEAN
            - ENUM
          description: Tipo do valor esperado no filtro
        operators:
          type: array
          items:
            type: string
            enum:
              - EQ
              - IN
              - GTE
              - LTE
              - BETWEEN
              - CONTAINS
          description: Operadores permitidos
        values:
          type: array
          items:
            type: string
          nullable: true
          description: Valores possíveis quando `type` for `ENUM`
        required:
          type: boolean
          nullable: true
          description: Indica se o filtro precisa ser informado
      required:
        - field
        - label
        - type
        - operators
        - values
        - required
      description: ExportFilter
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http

````