Referred signups

Retrieve all

GET https://notifycame.com/api/referrals-users/
curl --request GET \
--url 'https://notifycame.com/api/referrals-users/' \
--header 'Authorization: Bearer {api_key}' \
Parameters Details Description
referred_by_has_converted Optional Integer Allowed values: 0, 1
datetime_field Optional String Allowed values: datetime
datetime_start Optional String Filter results starting from this datetime. Y-m-d H:i:s format.
datetime_end Optional String Filter results up to this datetime. Y-m-d H:i:s format.
order_by Optional String What field to order the results by. Allowed values are: datetime, referred_by_has_converted.
order_type Optional String The ordering of the results. Allowed values are: ASC for ascending ordering, and DESC for descending ordering.
page Optional Integer The page number that you want results from. Defaults to 1.
results_per_page Optional Integer How many results you want per page. Allowed values are: 10, 25, 50, 100, 250, 500, 1000. Defaults to 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-06 12:16:28",
            "currency": "USD",
            "datetime": "2026-09-06 12:16:28"
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total_results": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://notifycame.com/api/referrals-users?page=1",
        "last": "https://notifycame.com/api/referrals-users?page=1",
        "next": null,
        "prev": null,
        "self": "https://notifycame.com/api/referrals-users?page=1"
    }
}