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

# Listar produtos

> Lista todos os produtos disponíveis ao cliente, com as empresas em que são válidos.



## OpenAPI

````yaml openapi.yaml GET /v1/products
openapi: 3.1.0
info:
  title: Pipo Public API
  version: 0.2.0
  description: >
    API pública da Pipo Saúde para integração de movimentações de benefícios

    (inclusões, exclusões e consultas) por parceiros e sistemas de folha de
    pagamento.
  contact:
    name: Pipo Engineering
    email: felipe.rodopoulos@piposaude.com.br
servers:
  - url: https://api.pipo.health
    description: Homologação (staging)
  - url: https://api.piposaude.com.br
    description: Produção
security:
  - bearerAuth: []
tags:
  - name: Autenticação
    description: Obtenção do token de acesso.
  - name: Empresas
    description: Consulta de empresas e seus produtos.
  - name: Benefícios
    description: Consulta de produtos/benefícios disponíveis.
  - name: Movimentações
    description: Inclusões, exclusões e histórico de movimentações.
  - name: Membros
    description: Consulta de membros e seus benefícios.
  - name: Solicitações
    description: Consulta do status de requisições assíncronas.
  - name: Health Check
    description: Verificação de disponibilidade.
paths:
  /v1/products:
    get:
      tags:
        - Benefícios
      summary: Listar produtos
      description: >-
        Lista todos os produtos disponíveis ao cliente, com as empresas em que
        são válidos.
      responses:
        '200':
          description: Lista de produtos.
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: array
                    items:
                      $ref: '#/components/schemas/ProductWithCompanies'
              example:
                result:
                  - product-id: 456e7890-e89b-12d3-a456-426614174001
                    product-name: Plano Saúde Premium
                    carrier-name: HealthCorp
                    product-type: health-insurance
                    valid-for-companies:
                      - company-id: 123e4567-e89b-12d3-a456-426614174000
                        name: Acme Corporation
                        tax-id: '12345678000190'
                        allowed-dependent-types:
                          - spouse
                          - child
                          - ward
                        allowed-start-options:
                          - on-inclusion-date
                          - on-admission-date
                          - on-next-billing-period
                  - product-id: 789e0123-e89b-12d3-a456-426614174005
                    product-name: Plano Dental Básico
                    carrier-name: DentalCorp
                    product-type: dental-insurance
                    valid-for-companies:
                      - company-id: 123e4567-e89b-12d3-a456-426614174000
                        name: Acme Corporation
                        tax-id: '12345678000190'
                        allowed-dependent-types:
                          - spouse
                          - child
                          - ward
                          - parent
                        allowed-start-options:
                          - on-inclusion-date
                          - on-admission-date
                          - on-next-billing-period
components:
  schemas:
    ProductWithCompanies:
      allOf:
        - $ref: '#/components/schemas/CompanyProduct'
        - type: object
          required:
            - valid-for-companies
          properties:
            valid-for-companies:
              type: array
              items:
                $ref: '#/components/schemas/CompanyRef'
    CompanyProduct:
      type: object
      required:
        - product-id
        - product-name
        - carrier-name
        - product-type
      properties:
        product-id:
          type: string
          format: uuid
        product-name:
          type: string
        carrier-name:
          type: string
          description: Nome da operadora que fornece o produto.
        product-type:
          $ref: '#/components/schemas/ProductType'
        allowed-dependent-types:
          type: array
          items:
            $ref: '#/components/schemas/RelationshipType'
        allowed-start-options:
          type: array
          items:
            $ref: '#/components/schemas/StartOption'
    CompanyRef:
      type: object
      required:
        - company-id
        - name
        - tax-id
      properties:
        company-id:
          type: string
          format: uuid
        name:
          type: string
        tax-id:
          $ref: '#/components/schemas/Cnpj'
    ProductType:
      type: string
      description: Tipo de produto/benefício.
      enum:
        - health-insurance
        - dental-insurance
        - life-insurance
        - mental-health
        - gym
        - pet-insurance
        - private-pension
        - air-medical-transport
        - health-navigation
    RelationshipType:
      type: string
      description: Tipo de relação do dependente com o titular.
      enum:
        - adopted-child
        - child
        - companion
        - grandchild
        - grandparent
        - great-grandchild
        - niece-or-nephew
        - parent-in-law
        - parent
        - sibling
        - spouse
        - stepchild
        - uncle-or-aunt
        - unknown
        - ward
    StartOption:
      type: string
      description: >
        Opção de início do benefício.

        `on-inclusion-date`, `on-admission-date`, `on-next-billing-period`,
        `on-current-billing-period`(esta última quando `on-next-billing-period`
        está habilitada; ver Convenções).
      enum:
        - on-inclusion-date
        - on-admission-date
        - on-next-billing-period
        - on-current-billing-period
    Cnpj:
      type: string
      description: >-
        CNPJ (Cadastro Nacional da Pessoa Jurídica). Aceita apenas dígitos ou
        formatado.
      examples:
        - '12345678000190'
        - 12.345.678/0001-90
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Token Bearer obtido em `POST /v1/authenticate`.

````