User Lists

List User Lists

Returns the custom fan lists. The server-side sort call is fired before fetching, so results are consistent across requests. Requires permission api_user_lists_list.

https://public-api.buffmetrics.com
GET/v1/{account_id}/user-lists
Bearer

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

  • limitinteger

    Default 10. Min 1, max 100.

  • offsetinteger

    Pagination offset.

  • sort_bystring

    custom (default), recent, name, or people.

  • sort_dirstring

    asc (default) or desc.

  • querystring

    Case-insensitive substring match against the list name. Omit to return all lists.

  • related_userstring

    OnlyFans numeric user ID. When set, results are restricted to lists that already contain that fan.

curl --request GET "https://public-api.buffmetrics.com/v1/acct_XXXXX/user-lists?limit=20&offset=0&sort_by=sample_sort_by" \
  --header "Authorization: Bearer YOUR_API_KEY"

Response

200
{
"data":{
"list":[
0:{
"id":"giphy_XXXXX"
"type":"custom"
"name":"VIP Fans"
"usersCount":50
"postsCount":0
}
]
"hasMore":true
"sort":"custom"
"order":"asc"
}
"_pagination":{
"next_page":"/v1/100000001/user-lists?limit=10&offset=10&sort_by=custom&sort_dir=asc"
}
"_meta":{
"_credits":{
"used":1
}
"_rate_limits":{
"limit_minute":1000
"remaining_minute":999
"limit_day":50000
"remaining_day":49999
}
}
}