Error

A valid request URL is required to generate request examples

{
  "data": {
    "rule": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "assignments": [
      {
        "firmId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "firmName": "<string>",
        "referralInstructions": "<string>"
      }
    ]
  },
  "meta": {
    "requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

Routing

Evaluate re-referral routing for an existing case

Evaluates routing rules for an existing case as if it were being re-referred. Extracts the case profile (case type, jurisdiction, county, tier, category) from the existing case record and matches it against the caller’s routing rules.

Key differences from /routing/evaluate:

Automatic firm exclusion: Firms that already received a referral for this case from the caller are excluded from the returned assignments.
Automatic attempt counting: The referralAttempt is set to the number of previous referrals + 1, so attempt-based routing conditions are applied correctly.
Flexible case identifier: The caseId parameter accepts a case UUID, referral UUID, reference number (e.g., ABC-0001), or external CMS ID.

Returns data: null when no rule matches after exclusions are applied. The response shape is identical to /routing/evaluate — an ordered array of firm assignments with referral instructions.

GET

routing

re-refer

Error

A valid request URL is required to generate request examples

{
  "data": {
    "rule": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "assignments": [
      {
        "firmId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "firmName": "<string>",
        "referralInstructions": "<string>"
      }
    ]
  },
  "meta": {
    "requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

Authorizations

X-API-Key

string

header

required

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

caseId

string

required

Flexible case identifier — accepts a base case UUID, referral UUID, reference number (e.g., ABC-0001), or external CMS ID

tier

integer

Routing tier to evaluate (optional)

Response

Matched routing rule with ordered firm assignments (excluding previously referred firms), or data: null if no rule matches

data

object

required

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).

Show child attributes