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.fansmetric.com

GET/v1/{account_id}/user-lists

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

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.

Response Fields

dataobject | array
Endpoint-specific payload. See the fields below for this route.
_pagination.next_pagestring
Relative URL for the next page, with the cursor or offset already applied. Append it to the API base URL and send it as-is. Omitted entirely on the last page.
_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	object \| array	Endpoint-specific payload. See the fields below for this route.
_pagination.next_page	string	Relative URL for the next page, with the cursor or offset already applied. Append it to the API base URL and send it as-is. Omitted entirely on the last page.
_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?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
}
}
}

List Later Scheduled Posts

Create User List