Evaluate routing rules for a case profile
Evaluates the caller’s routing rules against a hypothetical case profile and returns the highest-priority matching rule along with its ordered list of firm assignments. Each assignment includes the target firm’s ID, name, and any referral instructions (resolved from the firm relationship or the firm’s general instructions).
Returns data: null when no rule matches the given profile. When a rule does match, assignments is an ordered array (index 0 = highest priority) — a rule can map to one or many firms. This endpoint is read-only and does not create a referral.
Use the attempt parameter to simulate re-referral routing logic when rules have attempt-based conditions (e.g., different firm assignments for attempt 2 vs attempt 1).
Authorizations
Public API key (format cxp_<tier>_<body>, tier = ro|std|full). Scoped to a single firm. The firm must have public_api in allowedIntegrations.
Query Parameters
Case type name or ID to match against routing rule conditions
Jurisdiction code (e.g. NY) to match against routing rule conditions
Routing tier to evaluate (optional)
County name to match against routing rule conditions (optional)
Case type category to match against routing rule conditions (optional)
Routing attempt number (default 1)
Response
Matched routing rule with ordered firm assignments, or data: null if no rule matches
The result of evaluating routing rules against a case profile. Contains the single highest-priority rule that matched and an ordered array of all firm assignments configured on that rule. The first assignment is the highest-priority target firm. If no rule matches the given case profile, the entire data field is null (not an empty result object).