Back to API Overview
Matching Engine
Rules-based and AI-powered filtering and scoring of profiles — FILTER, SCORED, and AI match types
Endpoints (8)
GET
/api/matching/rulesAuth Required
List Matching Rules
Get all matching rules for the current user.
POST
/api/matching/rulesAuth Required
Create Matching Rule
Create a new matching rule. Three types are supported: FILTER (boolean pass/fail), SCORED (weighted 0–100 score), and AI (LLM-powered evaluation using aiPrompt).
GET
/api/matching/rules/{id}Auth Required
Get Matching Rule
Get a matching rule by ID.
PATCH
/api/matching/rules/{id}Auth Required
Update Matching Rule
Update a matching rule's criteria or metadata.
DELETE
/api/matching/rules/{id}Auth Required
Delete Matching Rule
Delete a matching rule.
POST
/api/matching/previewAuth Required
Preview Matching
Test a matching rule against sample profiles before saving.
POST
/api/matching/executeAuth Required
Execute Matching Rule
Run a matching rule against all profiles and store results.
GET
/api/matching/resultsAuth Required
List Matching Results
Get stored matching results for a rule.