Skip to main content
GET
/
routing
/
evaluate
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 (starts with cxp_). Required on every request.

Query Parameters

caseType
string
required

Case type name or ID to match against routing rule conditions

jurisdiction
string
required

Jurisdiction code (e.g. NY) to match against routing rule conditions

tier
integer

Routing tier to evaluate (optional)

county
string

County name to match against routing rule conditions (optional)

typeCategory
string

Case type category to match against routing rule conditions (optional)

attempt
integer
default:1

Routing attempt number (default 1)

Response

Routing evaluation result or null if no rule matches

data
object
required
meta
object
required