MYmytime
Referral Program Information

Show referral program information for a client

Returns referral program information for a client sent in the request

get/referral_program_information

Request

  • Base URL
    https://partners-api.mytime.com/api
  • Auth
    API key in header X-Api-Key

Query parameters

client_idinteger required

Client's mytime id

Headers

X-Subdomainstring

Merchant subdomain - Optional

Response

Shows referral program information for a given client

referral_credit_balancenumber float
credit_usednumber float
credit_refundednumber float
referral_linkstring

Example response

{
  "statistics": {
    "total_referrals": 4,
    "total_referees": 3,
    "total_activated_referrals": 4,
    "total_earned_credit": 35,
    "total_activated_credit": 65
  }
}

Changes

No recorded changes to this operation across all 12 revisions of this API.