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

# Verificar disponibilidade

> Retorna o estado básico do serviço. Não exige autenticação.



## OpenAPI

````yaml /openapi.json get /health
openapi: 3.1.0
info:
  title: Bevits API
  version: 1.0.0
  description: >-
    API pública somente leitura para consultar dados de CRM, compras e automação
    de uma organização Bevits.
  license:
    name: Proprietary
    identifier: LicenseRef-Proprietary
servers:
  - url: https://api.bevits.com
    description: Produção
security:
  - bearerAuth: []
tags:
  - name: Sistema
    description: Disponibilidade da API.
  - name: Identidade
    description: Identidade da organização e da API key.
  - name: Clientes
    description: Clientes e suas relações.
  - name: Segmentos
    description: Segmentos de clientes.
  - name: Compras
    description: Compras importadas das integrações.
  - name: Dados do CRM
    description: Tags e definições de atributos.
  - name: Automações
    description: Flows de automação.
  - name: Campanhas
    description: Campanhas de e-mail.
paths:
  /health:
    get:
      tags:
        - Sistema
      summary: Verificar disponibilidade
      description: Retorna o estado básico do serviço. Não exige autenticação.
      operationId: getHealth
      responses:
        '200':
          description: API disponível.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Health'
              example:
                status: ok
      security: []
components:
  schemas:
    Health:
      type: object
      required:
        - status
      properties:
        status:
          type: string
          const: ok
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: bvt_live_...
      description: API key criada nas configurações da organização.

````