> ## 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. # Consulta um veículo > Ficha do veículo com o cliente dono e o plano vigente que o cobre. Um veículo de outra contratante devolve a mesma resposta de recurso inexistente (404), nunca 403. ## OpenAPI ````yaml /referencia/openapi.json get /v1/vehicles/{id} 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/{id}: get: tags: - vehicles summary: Consulta um veículo description: >- Ficha do veículo com o cliente dono e o plano vigente que o cobre. Um veículo de outra contratante devolve a mesma resposta de recurso inexistente (404), nunca 403. operationId: PublicVehiclesController_getById parameters: - name: id required: true in: path schema: format: int64 example: 9001 responses: '200': description: Veículo encontrado content: application/json: schema: type: object required: - data - meta - errors properties: data: $ref: '#/components/schemas/PublicVehicle' meta: type: object description: Metadados da resposta — vazio nesta operação. properties: {} 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' customer: id: 501 name: Maria da Silva document: '12345678900' plan: contractPlanId: 73 contractCode: CT-2026-0001 planName: Plano Proteção Total appliesTo: CUSTOMER linkedTo: CUSTOMER vehicleId: null startedAt: '2026-08-20T13:05:00.000Z' meta: {} errors: [] '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 '404': description: NOT_FOUND content: application/json: example: data: null errors: - code: NOT_FOUND message: Attendance not found '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: PublicVehicle: 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`. customer: description: Cliente dono do veículo. allOf: - $ref: '#/components/schemas/PublicVehicleCustomer' plan: nullable: true description: >- Plano vigente que cobre este veículo — o vínculo feito no próprio veículo ou, na falta dele, o vínculo do cliente. Nulo quando nenhum plano cobre o veículo. type: object allOf: - $ref: '#/components/schemas/PublicPlanLink' required: - id - customerId - plate - chassis - renavam - brand - model - manufactureYear - modelYear - color - externalCode - status - createdAt - updatedAt - customer - plan PublicVehicleCustomer: type: object properties: id: type: integer format: int32 description: Identificador do cliente. name: type: string description: Nome do cliente. document: type: string description: CPF ou CNPJ do cliente, só dígitos. required: - id - name - document PublicPlanLink: type: object properties: contractPlanId: type: integer format: int32 description: >- Identificador do plano dentro do contrato (o mesmo de `GET /v1/company`). contractCode: type: string description: Código do contrato ao qual o plano pertence. planName: type: string description: Nome comercial do plano. appliesTo: type: string enum: - CUSTOMER - VEHICLE description: >- A que o plano se aplica: CUSTOMER (cobre todos os veículos do cliente) ou VEHICLE (cobre um veículo por vínculo). linkedTo: type: string enum: - CUSTOMER - VEHICLE description: >- Onde o vínculo foi feito: no cliente (CUSTOMER) ou num veículo dele (VEHICLE). vehicleId: type: integer format: int32 nullable: true description: >- Veículo do vínculo quando `linkedTo` é VEHICLE. Nulo quando é no cliente. startedAt: type: string format: date-time description: Início da vigência do vínculo (ISO 8601, UTC). required: - contractPlanId - contractCode - planName - appliesTo - linkedTo - vehicleId - startedAt 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.