Referred signups

检索所有

GET https://uptime4.com/api/referrals-users/
curl --request GET \
--url 'https://uptime4.com/api/referrals-users/' \
--header 'Authorization: Bearer {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-09-09 23:15:45",
            "currency": "EUR",
            "datetime": "2026-09-09 23:15:45"
        }
    ],
    "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"
    }
}