Referred signups
GET https://link.joyproject.com.br/api/referrals-users/
curl --request GET \
--url 'https://link.joyproject.com.br/api/referrals-users/' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://link.joyproject.com.br/api/referrals-users/' \
--header 'Authorization: Bearer {api_key}' \
| Parâmetros | Detalhes | Descrição |
|---|---|---|
| referred_by_has_converted | Opcional Inteiro | Valores permitidos: 0, 1 |
| datetime_field | Opcional Cadeia | Valores permitidos: datetime |
| datetime_start | Opcional Cadeia | Filtre os resultados a partir desta data e hora. Formato Y-m-d H:i:s. |
| datetime_end | Opcional Cadeia | Filtre os resultados até esta data e hora. Formato Y-m-d H:i:s. |
| order_by | Opcional Cadeia | Por qual campo ordenar os resultados. Os valores permitidos são: datetime, referred_by_has_converted. |
| order_type | Opcional Cadeia | A ordenação dos resultados. Os valores permitidos são: ASC para ordenação ascendente e DESC para ordenação descendente. |
| page | Opcional Inteiro | O número da página que deseja resultados. O padrão é 1. |
| results_per_page | Opcional Inteiro | Quantos resultados você deseja por página. Os valores permitidos são: 10, 25, 50, 100, 250, 500, 1000. O padrão é 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-21 13:30:03",
"currency": "BRL",
"datetime": "2026-09-21 13:30:03"
}
],
"meta": {
"page": 1,
"results_per_page": 25,
"total_results": 1,
"total_pages": 1
},
"links": {
"first": "https://link.joyproject.com.br/api/referrals-users?page=1",
"last": "https://link.joyproject.com.br/api/referrals-users?page=1",
"next": null,
"prev": null,
"self": "https://link.joyproject.com.br/api/referrals-users?page=1"
}
}