User Lists

Get User List

Returns metadata for a single custom user list — name, type, members count, sort. Requires permission api_user_lists_read.

https://public-api.fansmetric.com

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

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
Custom list ID.

Response Fields

data.idinteger
List ID.
data.typestring
custom for user-created lists; system lists use type-specific values.
data.namestring
Display name.
data.postsCountinteger
Members count (OF reuses the postsCount field name).
data.createdAtstring
ISO timestamp when the list was created.
data.canUpdateboolean
Whether the list can be renamed.
data.canDeleteboolean
Whether the list can be deleted.
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.id	integer	List ID.
data.type	string	`custom` for user-created lists; system lists use type-specific values.
data.name	string	Display name.
data.postsCount	integer	Members count (OF reuses the `postsCount` field name).
data.createdAt	string	ISO timestamp when the list was created.
data.canUpdate	boolean	Whether the list can be renamed.
data.canDelete	boolean	Whether the list can be deleted.
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" \
  --header "Authorization: Bearer YOUR_API_KEY"

Response

200

{"data":{"id":47382
"type":"custom"
"name":"VIP Fans"
"postsCount":15
"createdAt":"2026-01-12T08:00:00+00:00"
"canUpdate":true
"canDelete":true
}
"_meta":{"_credits":{"used":1
}
"_rate_limits":{"limit_minute":1000
"remaining_minute":999
"limit_day":50000
"remaining_day":49999
}
}
}

Attach Tags To Message

Bulk Add Users To List