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:14:56",
            "currency": "EUR",
            "datetime": "2026-09-09 23:14:56"
        }
    ],
    "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"
    }
}