Karia
Guides

Utilities

Verify API health and basic connectivity before deeper integration work

Utilities Guide

Use the utility endpoints for quick service health checks and lightweight connectivity validation.

Primary Workflow

  1. Call GET /utils/health to verify the API is healthy.
  2. Call GET /utils/ping for a simple connectivity check.
  3. Run these checks before exercising authenticated or workflow-heavy endpoint families.

Reference

Covered Operations

  • GET /utils/health
  • GET /utils/ping

Invoices

Retrieve invoice collections and individual invoice records

Create contact address POST

Add an address to an existing contact in the specified organisation and workspace.

On this page

Utilities GuidePrimary WorkflowReferenceCovered Operations