> ## 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.

# Listar contratos satelitals com filtros

> Retorna uma lista de contratos satelitals com base em filtros opcionais como nome, ID do cliente, ID externo, data de alerta e paginação.



## OpenAPI

````yaml GET /satellite/contracts
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:
  /satellite/contracts:
    get:
      description: >-
        Retorna uma lista de contratos satelitals com base em filtros opcionais
        como nome, ID do cliente, ID externo, data de alerta e paginação.
      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
        - name: client_id
          in: header
          required: true
          description: Id do cliente
          schema:
            type: string
            example: client_id
        - name: access_token
          in: header
          required: true
          description: Token gerado.
          schema:
            type: string
            example: access_token
        - name: name
          in: query
          required: false
          schema:
            type: string
            example: name
        - name: customerIdFilter
          in: query
          description: Filtro por ID do cliente
          required: false
          schema:
            type: string
            example: customerId
        - name: externalId
          in: query
          description: Filtro por ID externo
          required: false
          schema:
            type: string
            example: contractId
        - name: showContracted
          in: query
          description: Indica se deve mostrar apenas contratos já contratados
          required: false
          schema:
            type: boolean
            default: 'false'
            example: 'false'
        - name: alertDateFrom
          in: query
          description: Data inicial do alerta (formato ISO 8601)
          required: false
          schema:
            type: string
            format: date-time
            example: alertDateFrom
        - name: page
          in: query
          description: Número da página para paginação.
          required: false
          schema:
            type: integer
            default: 1
            example: 0
        - name: pageSize
          in: query
          description: Tamanho da página para paginação.
          required: false
          schema:
            type: integer
            default: 24
            example: 24
      responses:
        '200':
          description: OK
          content:
            application/json:
              example:
                id: 0
                customer:
                  id: 0
                  name: string
                description: string
                franchise: 0
                price: string
                sharingType: 0
                excMbPrice: string
                externalId: string
                createdAt: '2025-10-14T17:09:11.916Z'
                createdBy: string
                updatedAt: '2025-10-14T17:09:11.916Z'
                updatedBy: string
        '204':
          description: No Content
          content:
            application/json:
              example: No Content
        '400':
          description: Requisição mal formada.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: string
                    description: Erro encontrado.
              example:
                errors: Parameter not found
        '401':
          description: Requisição requer autenticação.
          content:
            application/json:
              schema:
                type: object
              example:
                valueInBytes: 1235
        '403':
          description: O acesso ao recurso foi negado.
          content:
            application/json:
              schema:
                type: object
              example:
                errors: O acesso ao recurso foi negado.
        '404':
          description: URI de API/Recurso inexistente para processamento.
          content:
            application/json:
              schema:
                type: object
              example:
                errors: URI de API/Recurso inexistente para processamento.
        '500':
          description: Erro Interno do servidor.
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: string
                    description: Erro encontrado.
              example:
                errors: Parameter not found

````