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

# API para Consulta de Contratos LoRaWAN

> Retorna informações de contratos LoRaWAN filtrados pelo nome 



## OpenAPI

````yaml GET /lorawan/broker/contract
openapi: 3.0.1
info:
  title: OpenAPI Auth Store
  description: API de exemplo para demonstração de autenticação e obtenção de tokens.
  license:
    name: Allcom Telecom
  version: 1.0.0
servers:
  - url: >-
      https://apicorp.algartelecom.com.br/telecom/product-Inventory-management/management/v1
security: []
paths:
  /lorawan/broker/contract:
    get:
      summary: 'Retorna informações de contratos LoRaWAN filtrados pelo nome '
      description: 'Retorna informações de contratos LoRaWAN filtrados pelo nome '
      parameters:
        - name: Content-Type
          in: header
          required: true
          description: |-
            Define o formato da requisição.

            🔹 **Valor padrão:**
            ```
            application/json
            ```
            📌 **Dica:** Copie e cole esse valor no campo Content-Type.
          schema:
            type: string
            example: application/json
            default: application/json
        - name: client_id
          in: header
          description: Identificador do client id do sensedia
          required: true
          schema:
            type: string
            example: client_id
        - name: access_token
          in: header
          description: Token gerado
          required: false
          schema:
            type: string
            example: access_token
        - name: name
          in: query
          description: Nome do contrato (planDesc) para filtro.
          required: true
          schema:
            type: string
            example: API_TESTE_EXTERNAL_ID
        - name: customerId
          in: query
          description: Identificador do cliente
          required: false
          schema:
            type: number
            example: '5464646'
        - name: externalId
          in: query
          description: Identificador externo
          required: false
          schema:
            type: number
            example: '5464646'
        - name: page
          in: query
          description: Número da página para paginação.
          required: false
          schema:
            type: integer
            format: int32
            default: 0
            example: 0
        - name: pageSize
          in: query
          description: Tamanho da página para paginação.
          required: false
          schema:
            type: integer
            format: int32
            default: 24
            example: 24
      responses:
        '200':
          description: Lista de contratos retornada com sucesso.
          content:
            application/json:
              example:
                - id: 607
                  customer:
                    id: 17961
                    name: Teste Faturamento MVNO
                  planDesc: API_TESTE_EXTERNAL_ID
                  status: ACTIVE
                  uplinkCount: 100
                  downlinkCount: 100
                  activationPrice: '4'
                  excessUplinkPrice: '15'
                  excessDownlinkPrice: '10'
                  loyaltyType: null
                  loyaltyTime: null
                  penalty: null
                  externalId: '17961'
                  createdAt: '2025-10-01T15:04:54'
                  createdBy: thiago.moreira@eticasolucoes.com.br
                  sharingType: 1
                  monthlyFee: '2'
                  nbVirtualAccounts: 0
        '400':
          description: Requisição inválida.
          content:
            application/json:
              example:
                errors: Parameter not found
        '401':
          description: Falha de autenticação (token inválido ou ausente).
          content:
            application/json:
              example:
                errors: Falha de autenticação (token inválido ou ausente).
        '500':
          description: Erro interno do servidor.
          content:
            application/json:
              example:
                errors: Erro interno do servidor.

````