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

# Listar ordens de fornecimento

> Retorna uma lista paginada de ordens de fornecimento publicadas no portal de transparência.



## OpenAPI

````yaml GET /transparency/orders
openapi: 3.0.3
info:
  title: StartGov — Portal da Transparência
  version: 1.0.0
  description: >-
    API pública do Portal da Transparência da plataforma StartGov. Todos os
    endpoints são públicos e não requerem autenticação.
servers:
  - url: https://api-bid.startgov.com.br/v1
    description: Produção
security: []
tags:
  - name: Licitações
    description: Processos licitatórios formais
  - name: Contratações Diretas
    description: Dispensas e inexigibilidades
  - name: Adesões
    description: Adesões a ARPs externas (carona)
  - name: Chamamentos Públicos
    description: Chamamentos públicos
  - name: ARPs
    description: Atas de Registro de Preços
  - name: Contratos
    description: Contratos de fornecimento
  - name: Ordens de Fornecimento
    description: Ordens emitidas contra contratos e ARPs
  - name: Auxiliares
    description: 'Endpoints de suporte: validação, enumerações e exportação'
paths:
  /transparency/orders:
    get:
      tags:
        - Ordens de Fornecimento
      summary: Listar ordens de fornecimento
      description: >-
        Retorna uma lista paginada de ordens de fornecimento publicadas no
        portal de transparência.
      operationId: listOrders
      parameters:
        - $ref: '#/components/parameters/organization_uuid'
        - $ref: '#/components/parameters/date_from'
        - $ref: '#/components/parameters/date_to'
        - $ref: '#/components/parameters/search'
        - $ref: '#/components/parameters/year'
        - $ref: '#/components/parameters/per_page'
      responses:
        '200':
          description: Lista paginada de ordens de fornecimento
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/SuccessResponse'
                  - properties:
                      data:
                        $ref: '#/components/schemas/PaginatedOrders'
components:
  parameters:
    organization_uuid:
      name: organization_uuid
      in: query
      required: true
      description: UUID da organização
      schema:
        type: string
        format: uuid
    date_from:
      name: date_from
      in: query
      description: >-
        Data inicial do filtro (YYYY-MM-DD). Deve ser usado em conjunto com
        `date_to`.
      schema:
        type: string
        format: date
        example: '2024-01-01'
    date_to:
      name: date_to
      in: query
      description: >-
        Data final do filtro (YYYY-MM-DD). Deve ser usado em conjunto com
        `date_from`.
      schema:
        type: string
        format: date
        example: '2024-12-31'
    search:
      name: search
      in: query
      description: Busca textual no objeto e número do processo
      schema:
        type: string
    year:
      name: year
      in: query
      description: Filtro por ano do exercício
      schema:
        type: integer
        example: 2024
    per_page:
      name: per_page
      in: query
      description: 'Número de registros por página. Mínimo: `1`. Máximo: `100`.'
      schema:
        type: integer
        default: 20
        minimum: 1
        maximum: 100
  schemas:
    SuccessResponse:
      type: object
      properties:
        success:
          type: boolean
          example: true
        message:
          type: string
          example: Dados recuperados com sucesso
        data: {}
    PaginatedOrders:
      allOf:
        - $ref: '#/components/schemas/PaginationMeta'
        - type: object
          properties:
            data:
              type: array
              items:
                $ref: '#/components/schemas/OrderListItem'
    PaginationMeta:
      type: object
      properties:
        current_page:
          type: integer
          example: 1
        per_page:
          type: integer
          example: 20
        total:
          type: integer
          example: 150
        last_page:
          type: integer
          example: 8
        from:
          type: integer
          example: 1
        to:
          type: integer
          example: 20
    OrderListItem:
      type: object
      properties:
        uuid:
          type: string
          format: uuid
        organization_uuid:
          type: string
          format: uuid
        date_issue:
          type: string
          format: date
        number:
          type: string
          example: OF-001/2024
        amount_total:
          type: string
        precision:
          type: integer
        object_details:
          type: string
        provider_company_name:
          type: string
        company_name:
          type: string
        company_name_short:
          type: string
        status_id:
          type: integer
          example: 1
        status:
          type: string
          example: EMITIDA

````