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

# Health check

> Returns service status, version, and environment details. Does not require authentication.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/health
openapi: 3.0.1
info:
  title: Stell API
  description: >-
    Create and manage passes for Apple Wallet and Google Wallet. One API for
    loyalty programs, membership cards, tickets, and more.
  termsOfService: https://getstell.com/terms
  contact:
    name: Stell API Support
    url: https://getstell.com/about?topic=Technical%20Support#contact
    email: hello@getstell.com
  version: '2026-08-09T18:16:19Z'
servers:
  - url: https://api.platform.getstell.com
    description: Production API
security:
  - StellApiAuthorizer: []
tags:
  - name: Companies
    description: Manage companies at the top of your tenant hierarchy.
  - name: Merchants
    description: Manage brands and business units within companies.
  - name: Stores
    description: Manage store locations and customer touchpoints.
  - name: Programs
    description: Configure pass programs for loyalty, membership, tickets, and more.
  - name: Pass Templates
    description: Define pass design and field layouts.
  - name: Passes
    description: Issue and manage customer passes for Apple and Google Wallet.
  - name: Terminals
    description: Configure terminals for tap-to-scan functionality.
  - name: Transactions
    description: Track pass usage, purchases, and redemptions.
  - name: Engagement
    description: Geofences, notifications, and location-based engagement features.
  - name: System
    description: Health checks and service monitoring.
paths:
  /v1/health:
    get:
      tags:
        - System
      summary: Health check
      description: >-
        Returns service status, version, and environment details. Does not
        require authentication.
      operationId: healthCheck
      responses:
        '200':
          description: 200 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthModel'
        '503':
          description: 503 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthModel'
components:
  schemas:
    HealthModel:
      title: Health Check Response
      required:
        - status
        - timestamp
      type: object
      properties:
        environment:
          type: string
          description: Current deployment environment (present when healthy)
        service:
          type: string
          description: Name of the service (present when healthy)
        region:
          type: string
          description: AWS region where the service is running (present when healthy)
        error:
          type: string
          description: >-
            Error message describing the health check failure (present when
            unhealthy)
        version:
          type: string
          description: API version (present when healthy)
        status:
          type: string
          description: Health status of the service
          enum:
            - healthy
            - unhealthy
        timestamp:
          type: string
          description: Current server timestamp in ISO 8601 format
          format: date-time
  securitySchemes:
    StellApiAuthorizer:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: |-
        API key authentication. Include your API key as a Bearer token.

        Example: `Bearer sk_prod_xxxxxx`

        Get your API key from the Stell Dashboard.

````