Referrals

List Referred Users

Returns users the creator has referred onto the platform. Toggle only_performers between referred creators (with per-creator earnings) and all referred users (creators + fans). Requires permission api_referrals_list_users.

https://public-api.fansmetric.com

GET/v1/{account_id}/referrals

API keyBearer

Authorization

default

AuthorizationBearer <token>

Send your FansMetric API key as a Bearer token in the Authorization header.

In: header

Path Parameters

account_id*integer
OnlyFans numeric account ID.

Query Parameters

start_datestring
Lower bound on joinDate. Default 2 years ago, UTC.
end_datestring
Upper bound on joinDate. Default end of today, UTC.
offsetinteger
Rows to skip. Page size is set by OnlyFans.
only_performersstring
1 (default) = referred creators only (rows include earnings). 0 = every referred user (creators + fans).

Response Fields

data.list[]array
Referred users in this page.
data.list[].idinteger
OnlyFans user ID.
data.list[].usernamestring
URL slug.
data.list[].namestring
Display name (may include emoji).
data.list[].joinDatestring
ISO 8601 — when this user signed up via the creator's referral link.
data.list[].earningsnumber
Only present when only_performers=1. Lifetime referral commission attributed to this referred creator.
data.list[].subscribedByboolean
Whether the calling account currently subscribes to this referred creator.
data.list[].subscribedOnboolean
Whether this referred creator currently subscribes to the calling account.
data.list[].viewstring
"ref" for rows from this endpoint.
data.hasMoreboolean
Whether more pages are available.
dataobject | array
Endpoint-specific payload. See the fields below for this route.
_meta._credits.usedinteger
Credits consumed by this request (currently always 1).
_meta._rate_limits.limit_minuteinteger
Maximum requests per minute for the organization.
_meta._rate_limits.remaining_minuteinteger
Remaining requests in the current minute window.
_meta._rate_limits.limit_dayinteger
Maximum requests per day for the organization.
_meta._rate_limits.remaining_dayinteger
Remaining requests in the current day window.

Field	Type	Description
data.list[]	array	Referred users in this page.
data.list[].id	integer	OnlyFans user ID.
data.list[].username	string	URL slug.
data.list[].name	string	Display name (may include emoji).
data.list[].joinDate	string	ISO 8601 — when this user signed up via the creator's referral link.
data.list[].earnings	number	Only present when `only_performers=1`. Lifetime referral commission attributed to this referred creator.
data.list[].subscribedBy	boolean	Whether the calling account currently subscribes to this referred creator.
data.list[].subscribedOn	boolean	Whether this referred creator currently subscribes to the calling account.
data.list[].view	string	`"ref"` for rows from this endpoint.
data.hasMore	boolean	Whether more pages are available.
data	object \| array	Endpoint-specific payload. See the fields below for this route.
_meta._credits.used	integer	Credits consumed by this request (currently always `1`).
_meta._rate_limits.limit_minute	integer	Maximum requests per minute for the organization.
_meta._rate_limits.remaining_minute	integer	Remaining requests in the current minute window.
_meta._rate_limits.limit_day	integer	Maximum requests per day for the organization.
_meta._rate_limits.remaining_day	integer	Remaining requests in the current day window.

curl --request GET "https://public-api.fansmetric.com/v1/100000001/referrals?start_date=2026-01-01%2000%3A00%3A00&end_date=2026-01-31%2023%3A59%3A59&offset=0" \
  --header "Authorization: Bearer YOUR_API_KEY"

Response

200

{"data":{"list":[0:{"id":100000009
"name":"Creator XX"
"username":"creator_XXXXX"
"displayName":""
"isVerified":true
"isActive":true
"subscribePrice":0
"currentSubscribePrice":0
"subscribedBy":true
"subscribedOn":true
"subscribedOnDuration":"4 months"
"subscribedByExpire":false
"subscribedByExpireDate":"2036-01-13T11:09:15+00:00"
"subscribedByAutoprolong":true
"joinDate":"2025-12-18T15:17:18+00:00"
"earnings":412.5
"canEarn":true
"view":"ref"
"listsStates":[]
}
]
"hasMore":false
}
"_meta":{"_credits":{"used":1
}
"_rate_limits":{"limit_minute":1000
"remaining_minute":999
"limit_day":50000
"remaining_day":49999
}
}
}

List Promotion Subscribers

Get Referral Balance