Skip to content

List the rule types the program accepts

GET /program/rule-types
Scopeprogram:read
Customer session tokenNot accepted: call from your server with an API key
Rate limit classread (limits)
Idempotency keyNot used
MCP toolcharm_list_program_rule_types

The catalog behind the admin’s “add a rule” pickers: every earning rule type, reward type and tier benefit type this shop may use, each with a JSON Schema of the fields it takes (type, range, choices, default) and the defaults a new rule starts from. Read this before creating or editing a rule; send only keys the schema lists.

NameInTypeDescription
kind (optional)querystring: earning, reward, benefitearning, reward or benefit. Omit for all three.

Returns ProgramRuleTypeList.

FieldTypeDescription
languagesobject or null(nullable)
dataarray of ProgramRuleType
{
"languages": {
"primary": "primary",
"published": [
"published"
]
},
"data": [
{
"type": "earn",
"kind": "earning",
"label": "Points per order",
"description": "Points for order #1042",
"category": "category",
"allow_multiple": false,
"fulfillment_modes": [
"fulfillment modes"
],
"restricted": "restricted",
"fields": {},
"defaults": {}
}
]
}
Terminal window
curl -X GET "https://charm.appfleece.app/api/v1/program/rule-types" \
-H "Authorization: Bearer chrm_live_..."

unauthorized · invalid_token · insufficient_scope · access_required · validation_error · rate_limited

Every error body carries code, message, request_id and a doc_url pointing at the matching entry in the error catalog.