Referred signups
GET https://uptime4.com/api/referrals-users/
curl --request GET \
--url 'https://uptime4.com/api/referrals-users/' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://uptime4.com/api/referrals-users/' \
--header 'Authorization: Bearer {api_key}' \
| Paramètres | Détails | Description |
|---|---|---|
| referred_by_has_converted | Optionnel Entier | Valeurs autorisées : 0, 1 |
| datetime_field | Optionnel Chaîne | Valeurs autorisées : datetime |
| datetime_start | Optionnel Chaîne | Filter results starting from this datetime. Y-m-d H:i:s format. |
| datetime_end | Optionnel Chaîne | Filter results up to this datetime. Y-m-d H:i:s format. |
| order_by | Optionnel Chaîne | Quel champ pour trier les résultats. Les valeurs autorisées sont : datetime, referred_by_has_converted. |
| order_type | Optionnel Chaîne | L'ordre des résultats. Les valeurs autorisées sont : ASC pour un ordre croissant, et DESC pour un ordre décroissant. |
| page | Optionnel Entier | Le numéro de page dont vous souhaitez obtenir les résultats. Par défaut, c'est 1. |
| results_per_page | Optionnel Entier | Combien de résultats souhaitez-vous par page ? Les valeurs autorisées sont : 10, 25, 50, 100, 250, 500, 1000. Par défaut, c'est 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-09-09 23:15:42",
"currency": "EUR",
"datetime": "2026-09-09 23:15:42"
}
],
"meta": {
"page": 1,
"results_per_page": 25,
"total_results": 1,
"total_pages": 1
},
"links": {
"first": "https://uptime4.com/api/referrals-users?page=1",
"last": "https://uptime4.com/api/referrals-users?page=1",
"next": null,
"prev": null,
"self": "https://uptime4.com/api/referrals-users?page=1"
}
}