🔧 Common Resource

Health checks and lookup data

Two publicly accessible utility endpoints: HealthCheck returns API operational status for monitoring, and Lookup provides ID type definitions.

2
Endpoints
Public
No Auth Required
Utility
Resource Type
57
Lookup Categories

Usage Notes

When

  • Check API availability and health
  • Retrieve lookup values for type IDs used across all resources

Requirements

  • No authentication required for both endpoints

Notes

  • HealthCheck for monitoring and availability verification
  • Lookup provides 57 categories of type ID definitions
  • Always use Lookup for type IDs - never hardcode values

Description

Common provides two public utility endpoints: HealthCheck for API status and Lookup for type ID definitions used across all resources.

Available Endpoints

GET HealthCheck Returns success response if API is operational
GET Lookup Returns ID-Value pairs for lookup categories