Get referral program settings

GET/v1/referral/admin/program

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Responses

200OK

enabledbooleanrequired

holding_daysinteger<int32>required

reward_amount_idrinteger<int64>required

rulesProgramRulesrequired

Show properties

milestonesMilestoneRule[] | nullrequired

Show properties

Array of MilestoneRule

bonus_idrinteger<int64>required

thresholdinteger<int32>required

referee_discount_idrinteger<int64>required

referee_discount_percentnumber<double>required

sale_commission_percentnumber<double>required

401Unauthorized

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

403Forbidden

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

500Internal Server Error

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X GET "/v1/referral/admin/program"

const response = await fetch("/v1/referral/admin/program", {
  method: "GET"
});

import requests

response = requests.get(
    "/v1/referral/admin/program",
)

Response

{
  "enabled": true,
  "holding_days": 0,
  "reward_amount_idr": 0,
  "rules": {
    "milestones": [
      {
        "bonus_idr": 0,
        "threshold": 0
      }
    ],
    "referee_discount_idr": 0,
    "referee_discount_percent": 0,
    "sale_commission_percent": 0
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}