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

# Healthcheck if API Key is working



## OpenAPI

````yaml https://api.offerclub.io/public-swagger-json get /v1.0/health
openapi: 3.0.0
info:
  title: Offerclub.io Public API
  description: >-
    External API for integrations. Authenticate every request with the
    `x-api-key` header.
  version: '1.0'
  contact: {}
  license:
    name: Legal Terms
    url: https://offerclub.io/legal/terms
servers:
  - url: https://api.offerclub.io
security: []
tags: []
paths:
  /v1.0/health:
    get:
      tags:
        - Healthcheck
      summary: Healthcheck if API Key is working
      operationId: healthcheck
      parameters: []
      responses:
        '200':
          description: Just a healthcheck
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthCheckResponseDto'
        '400':
          description: '`VALIDATION_ERROR` — Validation error'
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/ErrorResponseDto'
                  - type: object
                    properties:
                      details:
                        oneOf:
                          - $ref: >-
                              #/components/schemas/ValidationErrorDetailsResponseDto
        '401':
          description: '`UNAUTHORIZED` — Unauthorized — missing or invalid API key'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseDto'
        '500':
          description: '`INTERNAL_ERROR` — An unexpected error occurred'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseDto'
      security:
        - ApiKey: []
components:
  schemas:
    HealthCheckResponseDto:
      type: object
      properties:
        status:
          type: string
          description: The status of the health check
          example: ok
        timestamp:
          type: string
          description: The timestamp of the health check
          example: '2026-06-06T12:00:00.000Z'
        deployId:
          type: string
          description: >-
            Opaque identifier of the current deploy. Set by CI at image-build
            time and used by the deploy pipeline to detect when a new image is
            serving. Carries no source-code info — `"unknown"` when running
            outside of a CI-built image.
          example: a1b2c3d4e5f6g7h8
      required:
        - status
        - timestamp
        - deployId
    ErrorResponseDto:
      type: object
      properties:
        statusCode:
          type: number
          description: HTTP status code
          example: 400
        code:
          enum:
            - INTERNAL_ERROR
            - VALIDATION_ERROR
            - UNAUTHORIZED
          type: string
          description: Machine-readable error code
          example: VALIDATION_ERROR
        message:
          type: string
          description: Human-readable error message
          example: Validation failed
        details:
          type: object
          nullable: true
          description: Additional error details (e.g. validation errors, missing fields)
          example:
            errors:
              - email must be a string
      required:
        - statusCode
        - code
        - message
    ValidationErrorDetailsResponseDto:
      type: object
      properties:
        errors:
          description: The validation errors
          type: array
          items:
            $ref: '#/components/schemas/FlatValidationErrorDetailsResponseDto'
      required:
        - errors
    FlatValidationErrorDetailsResponseDto:
      type: object
      properties:
        field:
          type: string
          description: The field that failed validation
        message:
          type: string
          description: The message that explains the validation failure
      required:
        - field
        - message
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: API key for authentication (can be generated in the settings)

````