Skip to main content
Version: 1.1

List Rules


Endpoint Overview

The "List Rules" endpoint of the Rules Management API allows you to retrieve fraud detection rules defined for your organization. Use it with optional filters to fetch a subset of the rules according to your use case criteria.


If you have any inquiries or need clarifications about this endpoint, our Support Team is here to help.

Request Parameters

Query Parameters

The endpoint supports the following query parameters for more tailored rule retrieval:

  • ruleId: Filter by UUIDs of the rule.
  • version: Filter by version numbers.
  • externalId: Filter by external IDs.
  • status: Filter by rule status (enabled, disabled, archived).
  • action: Filter by action type (allow, review, deny).
  • serviceType: Filter by service type (self-service, custom).
  • priority: Filter by priority levels (from 1 highest to 5 lowest).
  • fullHistory: Set to true to retrieve the full history of rule changes. Default is false.

Example Request With Query Parameters


Response Parameters

Status CodeStatus MessageDescriptionSchema
200OKStandard response for successful HTTP requests.200 OK - Rules list response
4xx, 500, 501, 502, 503, 504errorVarious error messages for unsuccessful HTTP requests.Problem response

Code Samples

curl -X GET '' \
-H 'Content-Type: application/json' \
-H "authorisation: Bearer $ACCESS_TOKEN"