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

# Read a compact business overview

> Permission-aware orientation for the authenticated connected business. No new grant scope is required: each section independently requires its existing read scope. Identity is authenticated business metadata; missing permissions, unavailable data, incomplete inventories and timestamps are explicit. refresh=true bypasses the 60-second bounded cache. Activity uses tenant-local last_30d. Saved configuration and capability readiness are not live provider health, execution authorization, or delivery/booking proof. No tenant/admin override, provider calls, transcripts, prompts, schemas or credentials. Use detailed inspection tools for follow-up and fresh checks before actions. This helper adds no Lana action debit.



## OpenAPI

````yaml /openapi.json get /business/overview
openapi: 3.0.3
info:
  title: Visito M2M API
  version: 1.0.0
  description: >-
    Tenant-scoped server-to-server API for channels, conversations, commerce,
    custom AI tools, and WhatsApp templates. Send operations are asynchronous
    and return queued acknowledgements. Expansion adds conversation controls,
    knowledge, sales opportunities, delivery status, reporting, and signed
    webhooks.
servers:
  - url: https://platform-api.visitoai.com/m2m/v1
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Channels
  - name: Conversations
  - name: Commerce
  - name: Custom tools
  - name: WhatsApp templates
  - name: Properties
  - name: Knowledge
  - name: Sales CRM
  - name: Delivery
  - name: Reporting
  - name: Webhooks
paths:
  /business/overview:
    get:
      summary: Read a compact business overview
      description: >-
        Permission-aware orientation for the authenticated connected business.
        No new grant scope is required: each section independently requires its
        existing read scope. Identity is authenticated business metadata;
        missing permissions, unavailable data, incomplete inventories and
        timestamps are explicit. refresh=true bypasses the 60-second bounded
        cache. Activity uses tenant-local last_30d. Saved configuration and
        capability readiness are not live provider health, execution
        authorization, or delivery/booking proof. No tenant/admin override,
        provider calls, transcripts, prompts, schemas or credentials. Use
        detailed inspection tools for follow-up and fresh checks before actions.
        This helper adds no Lana action debit.
      operationId: getBusinessOverview
      parameters:
        - name: refresh
          in: query
          required: false
          description: >-
            Bypass cached summaries after configuration changes. Defaults to
            false.
          schema:
            type: boolean
            default: false
      responses:
        '200':
          description: >-
            Compact overview; sections can independently be unavailable or
            unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessOverview'
        '401':
          description: Authentication required
        '403':
          description: Connected business or current admin unavailable
        '429':
          description: Bounded overview capacity is full
      security:
        - BearerAuth: []
components:
  schemas:
    BusinessOverview:
      type: object
      additionalProperties: false
      required:
        - version
        - generatedAt
        - business
        - cache
        - complete
        - sections
        - topBlockers
      properties:
        version:
          type: integer
          enum:
            - 1
        generatedAt:
          type: string
          format: date-time
        business:
          type: object
          additionalProperties: false
          required:
            - tenantId
            - name
            - timezone
            - locale
            - useCases
            - observedAt
          properties:
            tenantId:
              type: string
            name:
              type: string
            timezone:
              type: string
            locale:
              type: string
              nullable: true
            useCases:
              type: array
              maxItems: 4
              items:
                type: string
            observedAt:
              type: string
              format: date-time
        cache:
          type: object
          additionalProperties: false
          required:
            - hit
            - expiresAt
          properties:
            hit:
              type: boolean
            expiresAt:
              type: string
              format: date-time
        complete:
          type: boolean
        sections:
          type: object
          additionalProperties: false
          required:
            - properties
            - channels
            - integrationsActions
            - knowledge
            - automation
            - crm
            - offerings
            - activity
            - attention
          properties:
            properties:
              $ref: '#/components/schemas/BusinessOverviewSection'
            channels:
              $ref: '#/components/schemas/BusinessOverviewSection'
            integrationsActions:
              $ref: '#/components/schemas/BusinessOverviewSection'
            knowledge:
              $ref: '#/components/schemas/BusinessOverviewSection'
            automation:
              $ref: '#/components/schemas/BusinessOverviewSection'
            crm:
              $ref: '#/components/schemas/BusinessOverviewSection'
            offerings:
              $ref: '#/components/schemas/BusinessOverviewSection'
            activity:
              $ref: '#/components/schemas/BusinessOverviewSection'
            attention:
              $ref: '#/components/schemas/BusinessOverviewSection'
        topBlockers:
          type: array
          maxItems: 5
          items:
            type: object
            additionalProperties: false
            required:
              - section
              - code
              - resourceId
              - inspectionTool
              - integrationId
            properties:
              section:
                type: string
                enum:
                  - properties
                  - channels
                  - integrationsActions
                  - knowledge
                  - automation
                  - crm
                  - offerings
                  - activity
                  - attention
              code:
                type: string
              resourceId:
                type: string
                nullable: true
              inspectionTool:
                type: string
              integrationId:
                type: string
                nullable: true
    BusinessOverviewSection:
      type: object
      additionalProperties: false
      required:
        - state
        - observedAt
        - complete
        - data
      properties:
        state:
          type: string
          enum:
            - available
            - partial
            - unavailable
            - unauthorized
            - unconfigured
        observedAt:
          type: string
          format: date-time
          nullable: true
        complete:
          type: boolean
        data:
          type: object
          additionalProperties: true
          nullable: true
        reason:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Visito M2M API key
      description: Server-side tenant-scoped credential created from Build > API Keys.

````

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