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

# Listar Produtos

> Lista produtos de forma paginada.



## OpenAPI

````yaml GET /products
openapi: 3.1.0
info:
  title: API Morada.ai
  version: 1.0.0
  description: >-
    Boas-vindas a documentacao da API Morada.ai!


    O escopo dessa documentacao e o cadastro e ingestao de leads dentro da
    M.I.A, com cada metodo tendo sua especificidade detalhada.


    Caso haja duvidas sobre a API, entre em contato direto com nosso time de
    engenharia em team.engineering@morada.ai, ou caso seja uma duvida geral,
    entre em contato com nosso time de atendimento atraves de seu Account
    Manager, ou atraves do e-mail help@morada.ai.
  contact:
    name: Morada.ai Engineering
    email: team.engineering@morada.ai
servers:
  - url: https://mia-gateway.morada.ai
    description: Servidor de producao
security:
  - apiKey: []
tags:
  - name: Deals
    description: Operacoes relacionadas a negocios (deals)
  - name: Leads
    description: Operacoes relacionadas a ingestao de leads
  - name: Notificacoes
    description: Envio de notificacoes e mensagens template via WhatsApp
  - name: Produtos
    description: Consulta e busca de produtos cadastrados
paths:
  /products:
    get:
      tags:
        - Produtos
      summary: Listar Produtos
      description: Lista produtos de forma paginada.
      operationId: listProducts
      parameters:
        - name: page
          in: query
          required: false
          description: 'Numero da pagina (opcional, padrao: 1)'
          schema:
            type: integer
            default: 1
            minimum: 1
        - name: size
          in: query
          required: false
          description: 'Quantidade de itens por pagina (opcional, padrao: 10)'
          schema:
            type: integer
            default: 10
            minimum: 1
      responses:
        '200':
          description: Lista de produtos retornada com sucesso
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductListResponse'
              example:
                products:
                  - productId: 49de5ba2-d5a5-436f-843f-5e6ab5ce530a
                    productName: Apartamento teste
                    status: Em Obras
                    agents:
                      - id: 83
                        name: Iago - Morada.ai (Staging)
                        number: +55 11 1234-5678
                  - productId: 0351db1b-3664-4a43-961e-0dc8afed1259
                    productName: Funcao teste
                    status: Lancamento
                    agents: []
                pagination:
                  page: 1
                  size: 10
                  totalItems: 2
                  totalPages: 1
                  hasNextPage: false
                  hasPreviousPage: false
      security:
        - apiKey: []
components:
  schemas:
    ProductListResponse:
      type: object
      properties:
        products:
          type: array
          items:
            $ref: '#/components/schemas/Product'
          description: Lista de produtos
        pagination:
          $ref: '#/components/schemas/Pagination'
    Product:
      type: object
      properties:
        productId:
          type: string
          format: uuid
          description: Identificador unico do produto
        productName:
          type: string
          description: Nome do produto
        status:
          type: string
          description: 'Status do produto (ex: Em Obras, Lancamento)'
        agents:
          type: array
          items:
            $ref: '#/components/schemas/Agent'
          description: Lista de agentes associados ao produto
    Pagination:
      type: object
      properties:
        page:
          type: integer
          description: Pagina atual
        size:
          type: integer
          description: Quantidade de itens por pagina
        totalItems:
          type: integer
          description: Total de itens encontrados
        totalPages:
          type: integer
          description: Total de paginas
        hasNextPage:
          type: boolean
          description: Indica se existe uma proxima pagina
        hasPreviousPage:
          type: boolean
          description: Indica se existe uma pagina anterior
    Agent:
      type: object
      properties:
        id:
          type: integer
          description: ID do agente/instancia
        name:
          type: string
          description: Nome do agente
        number:
          type: string
          description: Numero de telefone do agente
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-morada-api-key
      description: Chave de API do parceiro. Fornecida pelo time da Morada.ai.

````