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

# Consultar identidade da marca

> Logo, cores, fontes, idioma, voz, links e rodapé usados nas receitas e nos e-mails gerados.



## OpenAPI

````yaml /openapi.json get /v1/brand-kit
openapi: 3.1.0
info:
  title: Bevits API
  version: 1.0.0
  description: >-
    API pública para consultar dados de CRM, compras e automação de uma
    organização Bevits, criar automações como rascunho para revisão e ativação,
    criar campanhas de WhatsApp Oficial como rascunho e montar segmentos e tags
    de clientes.
  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.
  - name: Conta e marca
    description: Contexto da conta, identidade da marca e imagens.
  - name: Receitas
    description: Automações prontas criadas a partir de receitas, com desfazer.
  - name: Templates de e-mail
    description: Criação e importação de templates de e-mail.
  - name: Eventos
    description: Eventos personalizados enviados pela loja e seus tipos.
paths:
  /v1/brand-kit:
    get:
      tags:
        - Conta e marca
      summary: Consultar identidade da marca
      description: >-
        Logo, cores, fontes, idioma, voz, links e rodapé usados nas receitas e
        nos e-mails gerados.
      operationId: getBrandKit
      responses:
        '200':
          $ref: '#/components/responses/BrandKit'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  responses:
    BrandKit:
      description: Identidade da marca.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BrandKit'
    Unauthorized:
      description: API key ausente, inválida, expirada ou revogada.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              type: authentication_error
              message: Invalid API key.
              request_id: req_07f6cdc3c20249d6afcd90b4
    RateLimited:
      description: Limite de requisições excedido.
      headers:
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
        X-RateLimit-Limit:
          $ref: '#/components/headers/RateLimitLimit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/RateLimitRemaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/RateLimitReset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RateLimitErrorResponse'
    InternalError:
      description: Erro inesperado no servidor.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    BrandKit:
      type: object
      properties:
        object:
          type: string
          const: brand_kit
        name:
          type: string
        logo_url:
          type:
            - string
            - 'null'
        colors:
          type: object
          properties:
            primary:
              type: string
            background:
              type: string
            surface:
              type: string
            text:
              type: string
            muted:
              type: string
          required:
            - primary
            - background
            - surface
            - text
            - muted
          additionalProperties: false
        fonts:
          type: object
          properties:
            heading:
              type:
                - string
                - 'null'
            body:
              type:
                - string
                - 'null'
          required:
            - heading
            - body
          additionalProperties: false
        locale:
          type: string
        voice_tone:
          type:
            - string
            - 'null'
        vocabulary:
          type: array
          items:
            type: string
        links:
          type: object
          properties:
            store:
              type: string
            contact:
              type:
                - string
                - 'null'
            instagram:
              type:
                - string
                - 'null'
            tiktok:
              type:
                - string
                - 'null'
            facebook:
              type:
                - string
                - 'null'
          required:
            - store
            - contact
            - instagram
            - tiktok
            - facebook
          additionalProperties: false
        footer_note:
          type:
            - string
            - 'null'
        source:
          type: string
          enum:
            - manual
            - extracted
        reviewed_at:
          anyOf:
            - type: string
              format: date-time
              pattern: >-
                ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
            - type: 'null'
          description: >-
            Quando a identidade foi revisada. Vazio enquanto ela é só uma
            sugestão.
        persisted:
          type: boolean
          description: >-
            false quando nada foi salvo ainda e a identidade foi montada a
            partir da loja.
      required:
        - object
        - name
        - logo_url
        - colors
        - fonts
        - locale
        - voice_tone
        - vocabulary
        - links
        - footer_note
        - source
        - reviewed_at
        - persisted
      additionalProperties: false
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/Error'
    RateLimitErrorResponse:
      allOf:
        - $ref: '#/components/schemas/ErrorResponse'
        - type: object
          required:
            - retry_after
          properties:
            retry_after:
              type: integer
              minimum: 1
              description: Segundos até uma nova tentativa.
    Error:
      type: object
      required:
        - type
        - message
        - request_id
      properties:
        type:
          type: string
          enum:
            - authentication_error
            - conflict
            - internal_error
            - invalid_request
            - not_found
            - permission_denied
            - rate_limited
            - validation_error
        code:
          type: string
          description: >-
            Motivo estável e legível por máquina dentro de type, como
            invalid_event_name. Presente quando o erro tem um motivo nomeado.
        message:
          type: string
        param:
          type: string
          description: >-
            Caminho completo do campo com problema, como customer.email ou
            events[3].name.
        suggestion:
          type: string
          description: Um valor que seria aceito, quando existe um óbvio.
        request_id:
          type: string
          pattern: ^req_[a-f0-9]{24}$
  headers:
    RetryAfter:
      description: Segundos até uma nova tentativa.
      schema:
        type: integer
        minimum: 1
    RateLimitLimit:
      description: Limite total da janela atual.
      schema:
        type: integer
        example: 600
    RateLimitRemaining:
      description: Requisições restantes na janela atual.
      schema:
        type: integer
        example: 599
    RateLimitReset:
      description: Instante UTC em que a janela atual termina.
      schema:
        type: string
        format: date-time
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: bvt_live_...
      description: API key criada nas configurações da organização.

````

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