Nookhive Logo
StyleguideAPI Reference

Utility API

Health checks, region data, and other utility endpoints.

Overview

The Utility API provides helper endpoints for health checks, region data, and other utility functions. These endpoints are useful for monitoring and building integrations.

Some utility endpoints do not require authentication.

Health Check

Monitor API availability and status.

GET/v1/health

Health Check

Returns the current health status of the API. This endpoint does not require authentication.

Example RequestBASH
curl -X GET "https://api.nookhive.com/v1/health"
ResponseJSON
{
  "status": "healthy",
  "timestamp": "2026-01-15T10:00:00Z",
  "version": "1.0.0",
  "services": {
    "database": "healthy",
    "storage": "healthy",
    "email": "healthy"
  }
}

✅ Using Health Checks

Use the health endpoint for:

  • Monitoring API availability in your infrastructure
  • Setting up automated alerts for downtime
  • Verifying connectivity before starting batch operations
  • Load balancer health checks

Regions

Access region and phone number formatting data.

GET/v1/regions/phone

Get Phone Regions

Returns a list of supported regions with phone number formats. Useful for building phone input forms.

Example RequestBASH
curl -X GET "https://api.nookhive.com/v1/regions/phone" \
  -H "Authorization: Bearer nk_live_your_api_key_here"
ResponseJSON
{
  "regions": [
    {
      "code": "US",
      "name": "United States",
      "dialCode": "+1",
      "format": "(XXX) XXX-XXXX",
      "example": "+1 (555) 123-4567"
    },
    {
      "code": "GB",
      "name": "United Kingdom",
      "dialCode": "+44",
      "format": "XXXX XXXXXX",
      "example": "+44 7911 123456"
    },
    {
      "code": "CN",
      "name": "China",
      "dialCode": "+86",
      "format": "XXX XXXX XXXX",
      "example": "+86 138 0013 8000"
    }
  ],
  "total": 240
}

Reference Data

Access reference data for building forms and integrations.

GET/v1/timezones

List Timezones

Returns a list of supported IANA timezones.

Example RequestBASH
curl -X GET "https://api.nookhive.com/v1/timezones" \
  -H "Authorization: Bearer nk_live_your_api_key_here"
ResponseJSON
{
  "timezones": [
    {
      "id": "America/New_York",
      "name": "Eastern Time",
      "offset": "-05:00",
      "offsetMinutes": -300
    },
    {
      "id": "Europe/London",
      "name": "Greenwich Mean Time",
      "offset": "+00:00",
      "offsetMinutes": 0
    },
    {
      "id": "Asia/Shanghai",
      "name": "China Standard Time",
      "offset": "+08:00",
      "offsetMinutes": 480
    }
  ]
}
GET/v1/currencies

List Currencies

Returns a list of supported currencies for payments and invoicing.

Example RequestBASH
curl -X GET "https://api.nookhive.com/v1/currencies" \
  -H "Authorization: Bearer nk_live_your_api_key_here"
ResponseJSON
{
  "currencies": [
    {
      "code": "USD",
      "name": "US Dollar",
      "symbol": "$",
      "decimalPlaces": 2
    },
    {
      "code": "EUR",
      "name": "Euro",
      "symbol": "€",
      "decimalPlaces": 2
    },
    {
      "code": "CNY",
      "name": "Chinese Yuan",
      "symbol": "¥",
      "decimalPlaces": 2
    },
    {
      "code": "HKD",
      "name": "Hong Kong Dollar",
      "symbol": "HK$",
      "decimalPlaces": 2
    }
  ]
}

ℹ️ Rate Limits

Utility endpoints have relaxed rate limits compared to other API endpoints. The health check endpoint is not rate limited. Other utility endpoints share the standard rate limit pool.