Referred signups
GET https://z-bio.link/api/referrals-users/
curl --request GET \
--url 'https://z-bio.link/api/referrals-users/' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--url 'https://z-bio.link/api/referrals-users/' \
--header 'Authorization: Bearer YOUR_API_KEY' \
| المعلمات | التفاصيل | الوصف |
|---|---|---|
| referred_by_has_converted | اختياري عدد صحيح | القيم المسموح بها: 0, 1 |
| datetime_field | اختياري نص | القيم المسموح بها: datetime |
| datetime_start | اختياري نص | Filter results starting from this datetime. Y-m-d H:i:s format. |
| datetime_end | اختياري نص | Filter results up to this datetime. Y-m-d H:i:s format. |
| order_by | اختياري نص | الحقل الذي ترتب النتائج به. القيم المسموح بها هي: datetime, referred_by_has_converted. |
| order_type | اختياري نص | ترتيب النتائج. القيم المسموح بها هي: ASC للترتيب التصاعدي، و DESC للترتيب التنازلي. |
| page | اختياري عدد صحيح | رقم الصفحة التي تريد النتائج منها. الافتراضي هو 1. |
| results_per_page | اختياري عدد صحيح | عدد النتائج التي تريدها في كل صفحة. القيم المسموح بها هي: 10, 25, 50, 100, 250, 500, 1000. الافتراضي هو 25. |
{
"data": [
{
"referral_code": "ref_a1b2c3",
"status": "converted",
"is_converted": true,
"payment_types": [
"one_time",
"recurring"
],
"commission_statuses": [
"pending",
"approved"
],
"total_affiliate_commissions": 2,
"total_affiliate_commissions_amount": 12.5,
"pending_affiliate_commissions": 1,
"approved_affiliate_commissions": 1,
"withdrawn_affiliate_commissions": 0,
"latest_affiliate_commission_datetime": "2026-11-13 04:49:40",
"currency": "USD",
"datetime": "2026-11-13 04:49:40"
}
],
"meta": {
"page": 1,
"results_per_page": 25,
"total_results": 1,
"total_pages": 1
},
"links": {
"first": "https://z-bio.link/api/referrals-users?page=1",
"last": "https://z-bio.link/api/referrals-users?page=1",
"next": null,
"prev": null,
"self": "https://z-bio.link/api/referrals-users?page=1"
}
}