Organizations

Get extraction rules

GET
/api/organizations/{organizationId}/extraction-rules

Returns the per-organization extraction rules for built-in contact fields and for custom fields defined under DynamicProperties for the given section type (defaults to "Contact"). Each rule contains mode (allowlist/blacklist), values, regex patterns, and an optional prompt.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

organizationId*string

Query Parameters

type?string
Default"Contact"

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/organizations/string/extraction-rules"
{  "success": true,  "data": {    "backgroundExtractionMode": "all",    "builtInFields": {      "province": {        "mode": "allowlist",        "values": [          "ON",          "QC",          "BC",          "AB"        ],        "regex": [          "^[A-Z]{2}$"        ]      }    },    "customFields": {      "creditScore": {        "mode": "allowlist",        "values": [],        "regex": [          "^\\d{3}$"        ],        "prompt": "Three-digit credit score"      }    }  }}