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

# Service health check

> Returns 200 OK with `{ "status": "ok" }` when the API is reachable and your API key is valid. Use this from your integration after deployment to confirm the credentials load correctly.



## OpenAPI

````yaml /openapi.yaml get /v1/health
openapi: 3.1.0
info:
  title: ProVision Public API
  version: 1.0.0
  description: >-
    Use the ProVision Public API to integrate with ProVision conversations,
    clients, users, and addresses. All endpoints accept and return JSON, are
    authenticated with an `x-api-key` header, and are scoped to a single partner
    tenant.
  contact:
    email: support@onevisionresources.com
    name: OneVision Resources Support
  license:
    name: Proprietary
servers:
  - url: https://connect.provisionapp.io
    description: Production
security: []
paths:
  /v1/health:
    get:
      tags:
        - system
      summary: Service health check
      description: >-
        Returns 200 OK with `{ "status": "ok" }` when the API is reachable and
        your API key is valid. Use this from your integration after deployment
        to confirm the credentials load correctly.
      operationId: getOpenApiHealth
      responses:
        '200':
          description: The API is reachable and the supplied API key is valid.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - ok
                required:
                  - status
      security:
        - OpenApiKeyAuth: []
components:
  securitySchemes:
    OpenApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Send the API key in the x-api-key header.

````