GET
/
v1
/
rule
/
list
Rule List
curl --request GET \
  --url https://api.decodahealth.com/v1/rule/list \
  --header 'API-KEY: <api-key>' \
  --header 'TENANT: <tenant>'
[
  {
    "amountGreaterThan": 123,
    "amountLessThan": 123,
    "delayInDays": 123,
    "id": "<string>",
    "lessThanOrEqualTo": 123,
    "message": "<string>",
    "method": "Native",
    "name": "<string>",
    "ruleSetId": "<string>"
  }
]

Headers

​
TENANT
string
required

The tenant you are making this request on behalf of

​
API-KEY
string
required

Your api key

Response

Successful Response

​
delayInDays
integer
required

Number of days to delay before applying the rule.

​
id
string
required

Unique identifier for the rule.

​
method
enum<string>
required

Communication method to be used for this rule.

Available options:
Native,
SMS,
MAIL,
CALL,
COLLECTIONS,
EMAIL,
SMS_AND_EMAIL
​
name
string
required

Name of the rule.

​
ruleSetId
string
required

Identifier of the rule set this rule belongs to.

​
amountGreaterThan
integer | null

Lower bound for the amount, exclusive.

​
amountLessThan
integer | null

Upper bound for the amount, exclusive.

​
lessThanOrEqualTo
integer | null

Upper bound for the amount, inclusive.

​
message
string | null

Message to be sent when applying this rule.