User Lists

List User List Members

Returns the members of a specific list. The sort call always fires before fetching. Requires permission api_user_lists_list_members.

https://public-api.fansmetric.com

GET/v1/{account_id}/user-lists/{list_id}/users

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.
list_id*integer
List ID. Use a system list slug (fans, following, friends, muted, recent, tagged) or a numeric custom list ID.

Query Parameters

limitinteger
Default 10. Min 1, max 100.
offsetinteger
Pagination offset.
sort_bystring
recent (default).
sort_dirstring
asc or desc (default).

Response Fields

data.list[].idinteger
OnlyFans user ID for the fan.
data.list[].namestring
Display name. Falls back to u{id} when not set by the user.
data.list[].usernamestring
Login handle. Falls back to u{id} when not set.
data.list[].displayNamestring
User-set display name. Often empty.
data.list[].avatarstring|null
Avatar URL. null when no avatar is set.
data.list[].avatarThumbsobject|null
Avatar thumbnails: c50, c144. null when no avatar.
data.list[].headerstring|null
Header image URL. null when not set.
data.list[].headerSizeobject|null
Header dimensions: width, height. May be null.
data.list[].headerThumbsobject|null
Header thumbnails: w480, w760. null when no header.
data.list[].isActiveboolean
Whether the account is active on OnlyFans.
data.list[].isBlockedboolean
Whether the fan is blocked by this account.
data.list[].isRestrictedboolean
Whether the fan is restricted by this account.
data.list[].isVerifiedboolean
OnlyFans verified flag.
data.list[].isPerformerboolean
Whether the fan is a creator on OnlyFans.
data.list[].isRealPerformerboolean
Whether the fan is a fully verified creator.
data.list[].lastSeenstring|null
RFC 3339 timestamp of the fan's last activity. null when never seen or hidden.
data.list[].subscribePricenumber
Base subscription price (USD).
data.list[].currentSubscribePricenumber
Current effective price after discounts (USD).
data.list[].subscribedByboolean
Whether the connected account is subscribed to this fan.
data.list[].subscribedByAutoprolongboolean
Whether that subscription auto-renews.
data.list[].subscribedByExpireboolean
Whether the connected account's subscription is set to expire.
data.list[].subscribedByExpireDatestring|null
Expiry timestamp for the connected account's subscription.
data.list[].subscribedByDataobject
Detail of the connected account's subscription to this fan: price, regularPrice, subscribeAt, expiredAt, renewedAt, duration, subscribes[], etc.
data.list[].subscribedOnboolean
Whether this fan is subscribed to the connected account.
data.list[].subscribedOnDurationstring
Duration label of the fan's subscription (e.g. 7 months).
data.list[].subscribedOnExpiredNowboolean
Whether the fan's subscription has already expired.
data.list[].subscribedOnDataobject
Detail of the fan's subscription to the connected account. Includes spend rollups: messagesSumm, postsSumm, tipsSumm, subscribesSumm, streamsSumm, totalSumm, plus subscribeAt, expiredAt, lastActivity, subscribes[].
data.list[].listsStatesarray
Membership in all visible lists (system + custom). Each entry: id, name, type, hasUser, canAddUser, cannotAddUserReason.
data.list[].canReceiveChatMessageboolean
Whether the connected account can DM this fan.
data.list[].canCommentStoryboolean
Whether the connected account can comment on the fan's stories.
data.list[].canLookStoryboolean
Whether the connected account can view the fan's stories.
data.list[].canPayInternalboolean
Whether internal payments are enabled.
data.list[].canReportboolean
Whether the fan can be reported.
data.list[].canRestrictboolean
Whether the fan can be restricted.
data.list[].canTrialSendboolean
Whether a free trial can be sent to this fan.
data.list[].canUnsubscribeboolean
Whether the connected account can unsubscribe from this fan.
data.list[].canEarnboolean
Whether the connected account can earn from this fan.
data.list[].canAddSubscriberboolean
Whether the fan can be added as a subscriber.
data.list[].hideChatboolean
Whether chat is hidden for this fan.
data.list[].hasStoriesboolean
Whether the fan has active stories.
data.list[].hasStreamboolean
Whether the fan is currently streaming.
data.list[].hasScheduledStreamboolean
Whether the fan has a scheduled stream.
data.list[].hasNotViewedStoryboolean
Whether the fan has unviewed stories.
data.list[].isPendingAutoprolongboolean
Whether an auto-renewal is pending.
data.list[].tipsEnabledboolean
Whether the fan accepts tips.
data.list[].tipsMinnumber
Minimum tip amount.
data.list[].tipsMaxnumber
Maximum tip amount.
data.list[].tipsMinInternalnumber
Minimum internal tip amount.
data.list[].tipsTextEnabledboolean
Whether tip messages are enabled.
data.list[].promoOffersarray
Active promo offers for this fan. Empty [] when none.
data.list[].noticestring
Profile notice text. Empty string when none.
data.list[].viewstring
Internal view marker from OnlyFans.
data.hasMoreboolean
Whether more results are available beyond offset + limit.
data.nextOffsetinteger
Offset to pass on the next request for the next page.
_pagination.next_pagestring
Relative URL preserving all supplied query parameters with offset bumped. Omitted on the last page.
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[].id	integer	OnlyFans user ID for the fan.
data.list[].name	string	Display name. Falls back to `u{id}` when not set by the user.
data.list[].username	string	Login handle. Falls back to `u{id}` when not set.
data.list[].displayName	string	User-set display name. Often empty.
data.list[].avatar	string\|null	Avatar URL. `null` when no avatar is set.
data.list[].avatarThumbs	object\|null	Avatar thumbnails: `c50`, `c144`. `null` when no avatar.
data.list[].header	string\|null	Header image URL. `null` when not set.
data.list[].headerSize	object\|null	Header dimensions: `width`, `height`. May be `null`.
data.list[].headerThumbs	object\|null	Header thumbnails: `w480`, `w760`. `null` when no header.
data.list[].isActive	boolean	Whether the account is active on OnlyFans.
data.list[].isBlocked	boolean	Whether the fan is blocked by this account.
data.list[].isRestricted	boolean	Whether the fan is restricted by this account.
data.list[].isVerified	boolean	OnlyFans verified flag.
data.list[].isPerformer	boolean	Whether the fan is a creator on OnlyFans.
data.list[].isRealPerformer	boolean	Whether the fan is a fully verified creator.
data.list[].lastSeen	string\|null	RFC 3339 timestamp of the fan's last activity. `null` when never seen or hidden.
data.list[].subscribePrice	number	Base subscription price (USD).
data.list[].currentSubscribePrice	number	Current effective price after discounts (USD).
data.list[].subscribedBy	boolean	Whether the connected account is subscribed to this fan.
data.list[].subscribedByAutoprolong	boolean	Whether that subscription auto-renews.
data.list[].subscribedByExpire	boolean	Whether the connected account's subscription is set to expire.
data.list[].subscribedByExpireDate	string\|null	Expiry timestamp for the connected account's subscription.
data.list[].subscribedByData	object	Detail of the connected account's subscription to this fan: `price`, `regularPrice`, `subscribeAt`, `expiredAt`, `renewedAt`, `duration`, `subscribes[]`, etc.
data.list[].subscribedOn	boolean	Whether this fan is subscribed to the connected account.
data.list[].subscribedOnDuration	string	Duration label of the fan's subscription (e.g. `7 months`).
data.list[].subscribedOnExpiredNow	boolean	Whether the fan's subscription has already expired.
data.list[].subscribedOnData	object	Detail of the fan's subscription to the connected account. Includes spend rollups: `messagesSumm`, `postsSumm`, `tipsSumm`, `subscribesSumm`, `streamsSumm`, `totalSumm`, plus `subscribeAt`, `expiredAt`, `lastActivity`, `subscribes[]`.
data.list[].listsStates	array	Membership in all visible lists (system + custom). Each entry: `id`, `name`, `type`, `hasUser`, `canAddUser`, `cannotAddUserReason`.
data.list[].canReceiveChatMessage	boolean	Whether the connected account can DM this fan.
data.list[].canCommentStory	boolean	Whether the connected account can comment on the fan's stories.
data.list[].canLookStory	boolean	Whether the connected account can view the fan's stories.
data.list[].canPayInternal	boolean	Whether internal payments are enabled.
data.list[].canReport	boolean	Whether the fan can be reported.
data.list[].canRestrict	boolean	Whether the fan can be restricted.
data.list[].canTrialSend	boolean	Whether a free trial can be sent to this fan.
data.list[].canUnsubscribe	boolean	Whether the connected account can unsubscribe from this fan.
data.list[].canEarn	boolean	Whether the connected account can earn from this fan.
data.list[].canAddSubscriber	boolean	Whether the fan can be added as a subscriber.
data.list[].hideChat	boolean	Whether chat is hidden for this fan.
data.list[].hasStories	boolean	Whether the fan has active stories.
data.list[].hasStream	boolean	Whether the fan is currently streaming.
data.list[].hasScheduledStream	boolean	Whether the fan has a scheduled stream.
data.list[].hasNotViewedStory	boolean	Whether the fan has unviewed stories.
data.list[].isPendingAutoprolong	boolean	Whether an auto-renewal is pending.
data.list[].tipsEnabled	boolean	Whether the fan accepts tips.
data.list[].tipsMin	number	Minimum tip amount.
data.list[].tipsMax	number	Maximum tip amount.
data.list[].tipsMinInternal	number	Minimum internal tip amount.
data.list[].tipsTextEnabled	boolean	Whether tip messages are enabled.
data.list[].promoOffers	array	Active promo offers for this fan. Empty `[]` when none.
data.list[].notice	string	Profile notice text. Empty string when none.
data.list[].view	string	Internal view marker from OnlyFans.
data.hasMore	boolean	Whether more results are available beyond `offset + limit`.
data.nextOffset	integer	Offset to pass on the next request for the next page.
_pagination.next_page	string	Relative URL preserving all supplied query parameters with `offset` bumped. Omitted on the last page.
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/user-lists/sample_list_id/users?limit=20&offset=0&sort_by=sample_sort_by" \
  --header "Authorization: Bearer YOUR_API_KEY"

Response

200

{"data":{"hasMore":true
"list":[0:{"id":100000004
"name":"Fan XX"
"username":"fan_XXXXX"
"displayName":""
"avatar":"https://public.onlyfans.com/.../avatar.jpg"
"avatarThumbs":{"c50":"https://thumbs.onlyfans.com/.../c50/avatar.jpg"
"c144":"https://thumbs.onlyfans.com/.../c144/avatar.jpg"
}
"header":"https://public.onlyfans.com/.../header.jpg"
"headerSize":{"width":500
"height":374
}
"headerThumbs":{"w480":"https://thumbs.onlyfans.com/.../w480/header.jpg"
"w760":"https://thumbs.onlyfans.com/.../w760/header.jpg"
}
"isActive":true
"isBlocked":false
"isRestricted":false
"isVerified":false
"isPerformer":false
"isRealPerformer":false
"isPendingAutoprolong":false
"lastSeen":null
"subscribePrice":0
"currentSubscribePrice":0
"subscribedBy":true
"subscribedByAutoprolong":true
"subscribedByExpire":false
"subscribedByExpireDate":"2035-10-31T11:57:25+00:00"
"subscribedIsExpiredNow":false
"subscribedByData":{"price":0
"regularPrice":0
"newPrice":0
"subscribePrice":0
"duration":"7 months"
"subscribeAt":"2025-10-14T01:11:43+00:00"
"renewedAt":"2035-10-31T00:00:00+00:00"
"expiredAt":"2035-10-31T11:57:25+00:00"
"discountPercent":0
"discountPeriod":1
"discountStartedAt":null
"discountFinishedAt":null
"hasActivePaidSubscriptions":false
"isMuted":false
"showPostsInFeed":true
"status":null
"unsubscribeReason":"No reason given"
"subscribes":[0:{"id":14223525731
"action":"return"
"type":"regular"
"userId":100000004
"subscriberId":100000001
"date":"2025-10-31T11:57:25+00:00"
"startDate":"2025-10-31T11:57:25+00:00"
"expireDate":"2035-10-31T11:57:25+00:00"
"cancelDate":null
"duration":3652
"discount":0
"price":0
"regularPrice":0
"earningId":0
"offerStart":null
"offerEnd":null
"isCurrent":true
}
]
}
"subscribedOn":true
"subscribedOnDuration":"7 months"
"subscribedOnExpiredNow":false
"subscribedOnData":{"price":0
"regularPrice":0
"newPrice":0
"subscribePrice":0
"duration":"7 months"
"subscribeAt":"2025-10-13T18:45:30+00:00"
"renewedAt":null
"expiredAt":"2036-05-11T00:20:38+00:00"
"lastActivity":"2026-05-11T00:20:38+00:00"
"discountPercent":0
"discountPeriod":1
"discountStartedAt":null
"discountFinishedAt":null
"hasActivePaidSubscriptions":false
"isMuted":false
"status":"Set to Expire"
"messagesSumm":120
"postsSumm":0
"tipsSumm":0
"subscribesSumm":0
"streamsSumm":0
"totalSumm":120
"recommendations":0
"unsubscribeReason":"No reason given"
"subscribes":[0:{"id":14912579866
"action":"return"
"type":"regular"
"userId":100000001
"subscriberId":100000004
"date":"2026-05-11T00:20:38+00:00"
"startDate":"2026-05-11T00:20:38+00:00"
"expireDate":"2036-05-11T00:20:38+00:00"
"cancelDate":null
"duration":3653
"discount":0
"price":0
"regularPrice":0
"earningId":0
"offerStart":null
"offerEnd":null
"isCurrent":true
}
]
}
"listsStates":[0:{"id":"fans"
"name":"Fans"
"type":"fans"
"hasUser":true
"canAddUser":false
"cannotAddUserReason":"ALREADY_EXISTS"
}
1:{"id":"following"
"name":"Following"
"type":"following"
"hasUser":true
"canAddUser":false
"cannotAddUserReason":"ALREADY_EXISTS"
}
2:{"id":"friends"
"name":"Friends"
"type":"friends"
"hasUser":false
"canAddUser":false
"cannotAddUserReason":"USER_NOT_PERFORMER"
}
3:{"id":"muted"
"name":"Muted"
"type":"muted"
"hasUser":false
"canAddUser":true
"cannotAddUserReason":null
}
4:{"id":"recent"
"name":"Recent (last 24 hours)"
"type":"recent"
"hasUser":false
"canAddUser":false
"cannotAddUserReason":"SYSTEM_LIST"
}
5:{"id":"tagged"
"name":"Tagged"
"type":"tagged"
"hasUser":false
"canAddUser":false
"cannotAddUserReason":"SYSTEM_LIST"
}
6:{"id":"1252268925"
"name":"VIP Fans"
"type":"custom"
"hasUser":true
"canAddUser":false
"cannotAddUserReason":"ALREADY_EXISTS"
}
]
"canAddSubscriber":false
"canCommentStory":true
"canLookStory":true
"canPayInternal":true
"canReceiveChatMessage":true
"canReport":true
"canRestrict":true
"canTrialSend":false
"canUnsubscribe":true
"canEarn":false
"hideChat":false
"hasStories":false
"hasStream":false
"hasScheduledStream":false
"hasNotViewedStory":false
"tipsEnabled":false
"tipsMin":5
"tipsMax":200
"tipsMinInternal":1
"tipsTextEnabled":true
"promoOffers":[]
"notice":""
"view":"x"
}
]
"nextOffset":12
}
"_pagination":{"next_page":"/v1/{account_id}/user-lists/{list_id}/users?limit=10&offset=10"
}
"_meta":{"_credits":{"used":1
}
"_rate_limits":{"limit_minute":1000
"remaining_minute":999
"limit_day":50000
"remaining_day":49999
}
}
}

Delete User List

Add User to List