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

# Lista veículos

> Lista os veículos dos clientes da contratante dona da chave, paginados por cursor, do mais recente ao mais antigo.



## OpenAPI

````yaml /referencia/openapi.json get /v1/vehicles
openapi: 3.0.0
info:
  title: Koolisys — API Pública
  description: >-
    Contrato da API pública de integração da Koolisys: atendimentos, catálogo de
    serviços, elegibilidade, cadastro e consulta de clientes e veículos e a
    própria contratante. Gerada a partir do código — rotas, DTOs de entrada,
    projeções de resposta e escopos declarados —, nunca mantida à mão.
  version: 1.0.0
  contact: {}
servers:
  - url: https://api-koolisys.eixoassistencia.com.br
    description: API pública da Koolisys
security: []
tags:
  - name: auth
    description: Emissão do token de curta duração a partir da chave de API
  - name: attendances
    description: Abertura, consulta e listagem de atendimentos
  - name: services
    description: Catálogo de serviços disponíveis
  - name: eligibility
    description: Consulta de elegibilidade de cliente e veículo
  - name: customers
    description: Cadastro, consulta, busca e listagem de clientes da contratante
  - name: vehicles
    description: Consulta e listagem de veículos da contratante
  - name: company
    description: 'A própria contratante: contratos vigentes e planos disponíveis'
  - name: meta
    description: A própria especificação
paths:
  /v1/vehicles:
    get:
      tags:
        - vehicles
      summary: Lista veículos
      description: >-
        Lista os veículos dos clientes da contratante dona da chave, paginados
        por cursor, do mais recente ao mais antigo.
      operationId: PublicVehiclesController_list
      parameters:
        - name: limit
          required: false
          in: query
          description: Itens por página (1 a 100, padrão 20)
          schema:
            example: 20
        - name: cursor
          required: false
          in: query
          description: Cursor da próxima página, devolvido em meta.nextCursor
          schema: {}
        - name: updatedSince
          required: false
          in: query
          description: Só veículos alterados a partir desta data/hora ISO 8601
          schema:
            example: '2026-08-01T00:00:00.000Z'
        - name: status
          required: false
          in: query
          description: Filtra por situação (ACTIVE ou INACTIVE)
          schema:
            example: ACTIVE
        - name: customerId
          required: false
          in: query
          description: Só veículos deste cliente
          schema:
            example: 501
        - name: plate
          required: false
          in: query
          description: Placa exata (hífen e caixa ignorados)
          schema:
            example: ABC1D23
      responses:
        '200':
          description: Página de veículos
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                  - meta
                  - errors
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PublicVehicleSummary'
                  meta:
                    $ref: '#/components/schemas/PublicVehiclePageMeta'
                  errors:
                    type: array
                    description: Sempre vazio numa resposta de sucesso.
                    items:
                      type: object
                    maxItems: 0
              example:
                data:
                  - id: 9001
                    customerId: 501
                    plate: ABC1D23
                    chassis: 9BWZZZ377VT004251
                    renavam: '12345678901'
                    brand: Fiat
                    model: Argo
                    manufactureYear: 2022
                    modelYear: 2023
                    color: Prata
                    externalCode: ERP-V-000456
                    status: ACTIVE
                    createdAt: '2026-08-20T13:02:00.000Z'
                    updatedAt: '2026-08-20T13:02:00.000Z'
                meta:
                  nextCursor: null
                errors: []
        '400':
          description: VALIDATION_ERROR
          content:
            application/json:
              example:
                data: null
                errors:
                  - code: VALIDATION_ERROR
                    message: 'customerDocument: Documento do cliente é obrigatório'
                    field: customerDocument
        '401':
          description: INVALID_TOKEN
          content:
            application/json:
              example:
                data: null
                errors:
                  - code: INVALID_TOKEN
                    message: Token inválido.
        '403':
          description: INSUFFICIENT_SCOPE
          content:
            application/json:
              example:
                data: null
                errors:
                  - code: INSUFFICIENT_SCOPE
                    message: Escopo insuficiente para este endpoint.
                    details:
                      requiredScope: attendances.read
        '429':
          description: RATE_LIMITED
          content:
            application/json:
              example:
                data: null
                errors:
                  - code: RATE_LIMITED
                    message: Limite de requisições excedido.
                    details:
                      retryAfterSeconds: 42
        '503':
          description: FEATURE_DISABLED
          content:
            application/json:
              example:
                data: null
                errors:
                  - code: FEATURE_DISABLED
                    message: 'Feature is disabled: public_api.enabled'
      security:
        - apiToken: []
components:
  schemas:
    PublicVehicleSummary:
      type: object
      properties:
        id:
          type: integer
          format: int32
          description: Identificador do veículo.
        customerId:
          type: integer
          format: int32
          description: Identificador do cliente dono do veículo.
        plate:
          type: string
          description: >-
            Placa normalizada: maiúsculas, sem hífen (padrão antigo ou
            Mercosul).
        chassis:
          type: string
          nullable: true
          description: Chassi (VIN, 17 caracteres).
        renavam:
          type: string
          nullable: true
          description: RENAVAM (11 dígitos).
        brand:
          type: string
          nullable: true
          description: Marca.
        model:
          type: string
          nullable: true
          description: Modelo.
        manufactureYear:
          type: integer
          format: int32
          nullable: true
          description: Ano de fabricação.
        modelYear:
          type: integer
          format: int32
          nullable: true
          description: Ano do modelo.
        color:
          type: string
          nullable: true
          description: Cor.
        externalCode:
          type: string
          nullable: true
          description: Código do veículo no sistema do parceiro, informado no cadastro.
        status:
          type: string
          enum:
            - ACTIVE
            - INACTIVE
          description: 'Situação do veículo: ACTIVE ou INACTIVE.'
        createdAt:
          type: string
          format: date-time
          description: Quando o veículo foi cadastrado (ISO 8601, UTC).
        updatedAt:
          type: string
          format: date-time
          description: >-
            Última alteração do cadastro (ISO 8601, UTC) — use em
            `updatedSince`.
      required:
        - id
        - customerId
        - plate
        - chassis
        - renavam
        - brand
        - model
        - manufactureYear
        - modelYear
        - color
        - externalCode
        - status
        - createdAt
        - updatedAt
    PublicVehiclePageMeta:
      type: object
      properties:
        nextCursor:
          type: string
          nullable: true
          description: >-
            Cursor opaco da próxima página — repasse em `?cursor=`. Nulo quando
            não há mais páginas.
      required:
        - nextCursor
  securitySchemes:
    apiToken:
      scheme: bearer
      bearerFormat: JWT
      type: http
      description: >-
        Token de curta duração devolvido por POST /v1/auth/token, carregando os
        escopos concedidos à chave — exigido por todo endpoint de dados.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.