referrals
Open an operation to see its authentication, its parameters and the fields of its request and response.
1 operation
GET/v1/referrals
The invitation link, the invited organizations and the credits earned.
/v1/referralsAuthentication: Dashboard session
Response 200
| Name | Type | Description |
|---|---|---|
coderequired | string | |
linkrequired | string | |
reward_eachrequired | integer | |
credits_earnedrequired | integer | |
invitedrequired | object | |
invited.statusrequired | enum | Values pending | qualified | rewarded | rejected |
invited.rejection_reasonrequired | enum | Values self_invite | same_email_domain | domain_already_rewarded | payment_method_already_rewarded | payment_method_of_referrer | payment_method_required | referred_org_deleted |
referralsrequired | array of object | |
referrals[].idrequired | string | |
referrals[].statusrequired | enum | Values pending | qualified | rewarded | rejected |
referrals[].referred_namerequired | string | |
referrals[].credits_awardedrequired | integer | |
referrals[].rejection_reasonrequired | enum | Values self_invite | same_email_domain | domain_already_rewarded | payment_method_already_rewarded | payment_method_of_referrer | payment_method_required | referred_org_deleted |
referrals[].created_atrequired | string (date-time) | |
referrals[].qualified_atrequired | string (date-time) | |
referrals[].rewarded_atrequired | string (date-time) |