Skip to main content
POST
ListRules

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
dimension
enum<string> | null

Restrict to one dimension. Omit to return both.

Available options:
CATEGORY_DIMENSION_UNSPECIFIED,
CATEGORY_DIMENSION_TECHNICAL,
CATEGORY_DIMENSION_GOVERNANCE
scope
enum<string> | null

Restrict to the workspace's own rules or to the platform-provided ones. Omit to return both.

Available options:
RULE_SCOPE_UNSPECIFIED,
RULE_SCOPE_GLOBAL,
RULE_SCOPE_WORKSPACE
pagination
Pagination · object

Pagination. Defaults to 200 rules per page.

Response

200 - application/json

Success

rules
CategorisationRule · object[]

Matching rules, in the order they are tried: workspace rules before platform-provided ones, then by descending priority.

pageInfo
PageInfo · object

Pagination cursor for the next page. Empty when this is the last page.