GET
/
v4
/
data-validation
/
rules
cURL
curl --request GET \
  --url https://api.kadoa.com/v4/data-validation/rules \
  --header 'x-api-key: <api-key>'
{
  "error": true,
  "data": [
    {
      "id": "abc123",
      "name": "Email Validation Rule",
      "description": "<string>",
      "ruleType": "custom_sql",
      "workflowId": "<string>",
      "groupId": "<string>",
      "userId": "<string>",
      "teamId": "<string>",
      "targetColumns": [
        "<string>"
      ],
      "parameters": {
        "sql": "<string>",
        "params": [
          "<any>"
        ],
        "prompt": "<string>"
      },
      "status": "enabled",
      "disabledReason": "<string>",
      "metadata": {},
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-15T10:30:00.000Z",
      "deletedAt": "2024-01-15T10:30:00.000Z",
      "deletedReason": "<string>"
    }
  ],
  "pagination": {
    "page": 1,
    "pageSize": 50,
    "totalItems": 150,
    "totalPages": 3
  }
}

Authorizations

x-api-key
string
header
required

API key for authentication

Query Parameters

groupId
string
workflowId
string
status
enum<string>
Available options:
preview,
enabled,
disabled
page
number
default:1
Required range: x >= 1
pageSize
number
default:50
Required range: 1 <= x <= 100
includeDeleted

Response

200

Paginated validation rules with metadata

error
boolean
required
data
Rule · object[]
required
pagination
object
required

Metadata for paginated responses including page info and totals