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

# Get health

> Get information about the health of the API. Useful to verify if the API is reachable and you can successfully authenticate against it.



## OpenAPI

````yaml /openapi.json get /partner/v1/health
openapi: 3.0.0
info:
  title: Venturu API Documentation
  version: 1.0.0
  description: This is the OpenAPI specification for Venturu.
servers:
  - url: https://www.venturu.com/api
    description: Production server
  - url: http://localhost:3000/api
    description: Local development server
security: []
paths:
  /partner/v1/health:
    get:
      tags:
        - Partner
      summary: Get health
      description: >-
        Get information about the health of the API. Useful to verify if the API
        is reachable and you can successfully authenticate against it.
      operationId: get-partner-v1-health
      parameters: []
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getHealthResponseSchema'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getHealthErrorResponseSchema'
      security:
        - BearerAuth: []
components:
  schemas:
    getHealthResponseSchema:
      type: object
      properties:
        status:
          type: string
          enum:
            - success
          description: Indicates that you can successfully connect to the API.
        permissions:
          type: array
          items:
            type: string
          description: The permissions granted to the key.
        timestamp:
          type: string
          description: The current server timestamp in ISO 8601 format.
      required:
        - status
        - permissions
        - timestamp
    getHealthErrorResponseSchema:
      type: object
      properties:
        status:
          type: string
          enum:
            - error
          description: Indicates that an error occurred.
        error:
          type: string
          description: A description of the error that occurred.
      required:
        - status
        - error
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer

````