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

# Health Check

> Verify that the JobTicket API is reachable and operational.

Ping this endpoint to confirm the API is up and accepting connections. No authentication is required.

## Authorizations

None required. This endpoint is publicly accessible.

## Response

<ResponseField name="(empty body)" type="null">
  A `204 No Content` response with no body is the only success signal. Any 5xx, timeout, or connection error indicates a service disruption.
</ResponseField>

<Note>
  Use this endpoint in health checks and readiness probes. If you receive anything other than `204`, treat the API as unavailable.
</Note>

<RequestExample>
  ```bash cURL theme={null}
  curl --request GET \
    --url https://v1-api.ticket-plus.app/health
  ```

  ```python Python theme={null}
  import requests

  res = requests.get("https://v1-api.ticket-plus.app/health")
  print(res.status_code)  # 204
  ```

  ```javascript Node.js theme={null}
  const res = await fetch("https://v1-api.ticket-plus.app/health");
  console.log(res.status); // 204
  ```
</RequestExample>

<ResponseExample>
  ```http 204 No Content theme={null}
  (empty body)
  ```
</ResponseExample>


## OpenAPI

````yaml GET /health
openapi: 3.0.3
info:
  title: JobTicket API
  description: >-
    The JobTicket B2B API lets you read employee data, manage HR integrations,
    and access employee documents programmatically. All endpoints use HTTP Basic
    Auth — pass your API key credentials from the Developer Portal as the
    username and password.
  version: 1.0.0
servers:
  - url: https://v1-api-staging.ticket-plus.app
    description: Staging server
  - url: https://v1-api.ticket-plus.app
    description: Production Server
security:
  - basicAuth: []
externalDocs:
  url: https://jobticket-docs.ticket-plus.app
  description: View our documentation to get more info
paths:
  /health:
    get:
      tags:
        - Health Checks
      summary: Check Service Health
      description: >-
        Returns a 204 with no body when the service is healthy. Use this
        endpoint to confirm the API is reachable before making other requests.
      responses:
        '204':
          description: Service is healthy and accepting requests.
          content:
            application/json:
              schema:
                description: Empty body — a 204 response means the service is healthy.
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: >-
        HTTP Basic Auth using your API key credentials. Use the username and
        password issued from the Developer Portal. Encode them as
        `Base64(username:password)` and pass in the `Authorization: Basic
        <token>` header.

````