Explorer/API Reference

API Reference

Static reference for 11 contract domains. No running server required.

Case Management

REST API for managing cases. A case is the long-lived relationship with a client or

Case Management Service API v0.1.0 Alpha
Client Management

REST API for managing persons. The specification defines CRUD operations

Person API v0.1.0 Alpha
Communication

API for the Communication domain — notices and correspondence to clients.

Communication Service API v1.0.0 Alpha
Data Exchange

REST API for the Data Exchange domain — the facade for all interactions

Data Exchange Adapter API v0.1.0 Alpha Data Exchange API v0.1.0 Alpha
Document Management

REST API for the Document Management domain — the central store for uploaded

Document Management API v0.1.0 Alpha
Eligibility

REST API for querying eligibility determinations and decisions. Determinations

Eligibility Adapter API v1.0.0 Stable Eligibility Service API v1.0.0 Stable
Intake

REST API for managing public assistance applications. Covers the full

Intake Service API v1.1.0 Beta
Platform

Cross-cutting platform services shared across all domains.

Platform API v0.1.0 Alpha
Scheduling

REST API for managing scheduling entities such as appointments.

Scheduling Service API v0.1.0 Alpha
Identity Access

Manages user accounts, roles, and permissions for safety net program APIs.

User Service API v0.1.0 Stable
Workflow

REST API for managing workflow entities such as tasks and queues.

Workflow Service API v0.1.0 Alpha