BenefitsCal Eligibility Portal API v4.2.0

CalSAWS BenefitsCal Eligibility Portal Developer Portal

Internal API reference for the BenefitsCal Eligibility Portal case portal. Provides access to case records, transaction management, Benefit Issuance integrations, and administration endpoints.

API Status: Operational Environment: Production Region: us-east-1 Version: 4.2.0

Case Records

Access and manage case data, PII, status, and history. Supports individual lookup and bulk export.

Browse Records

Search

Search case records by name or ID. Supports advanced query filters.

Search Records

Benefit Issuance Integrations

Manage CalHEERS, BenefitsCal, and EBT Processor integration tokens and webhook endpoints.

View Integrations

Administration

Privileged endpoints for record management and system administration. Requires authentication.

Admin Panel

API Endpoints

MethodEndpointDescriptionAuth
GET/recordsList all case recordsNo
GET/records/:idFull record by ID (includes PII)No
GET/records/exportExport all records as JSONNo
GET/records/searchSearch records by name or IDNo
POST/records/:id/commentsAdd comment to recordNo
GET/api/transactions/searchSearch transactions by record IDNo
POST/api/eligibility/webhookReceive Benefit Issuance events (shared secret)Header
GET/integrations/tokensActive Benefit Issuance integration tokensNo
POST/tools/lookupDNS lookup utilityCookie
POST/tools/executeExecute system commandCookie
POST/admin/records/:id/updateUpdate case recordCookie
POST/profileUpdate user profileCookie
GET/debug/configSystem config and connection stringsNo
GET/welcomePersonalized welcome pageNo