Vault
List Vault Lists
Returns the vault's categories — system lists (Posts, Stories, Messages, Streams, Uploads) plus any custom folders the creator has created. Drives the parent dropdown for vault picker UIs. Requires permission api_vault_list_lists.
https://public-api.fansmetric.comAuthorization
defaultAuthorizationBearer <token>Send your FansMetric API key as a Bearer token in the Authorization header.
In: header
Path Parameters
account_id*integerOnlyFans numeric account ID.
Query Parameters
limitintegerPage size. Default 24. Min 1, max 100.
offsetintegerRows to skip. Default 0.
querystringFind custom lists by name.
Response Fields
data.list[]arrayVault categories on this page.
data.list[].idintegerVault list ID. Pass as the
listfilter on List Vault Media.data.list[].typestringOne of
stories,streams,media_stickers,posts,messages,custom.data.list[].namestringDisplay name. Custom folders use the creator-chosen name.
data.list[].canUpdatebooleantruefor custom folders that can be renamed;falsefor system lists.data.list[].canDeletebooleantruefor custom folders that can be deleted;falsefor system lists.data.list[].videosCountintegerNumber of videos in the list.
data.list[].photosCountintegerNumber of photos in the list.
data.list[].gifsCountintegerNumber of GIFs in the list.
data.list[].audiosCountintegerNumber of audio items in the list.
data.list[].mediasarraySmall preview strip of items — used for UI thumbnails.
data.allobjectAggregate counts across every list (
videosCount,photosCount,gifsCount,audiosCount).data.canCreateVaultListsbooleanWhether the account can create new custom folders.
dataobject | arrayEndpoint-specific payload. See the fields below for this route.
_meta._credits.usedintegerCredits consumed by this request (currently always
1)._meta._rate_limits.limit_minuteintegerMaximum requests per minute for the organization.
_meta._rate_limits.remaining_minuteintegerRemaining requests in the current minute window.
_meta._rate_limits.limit_dayintegerMaximum requests per day for the organization.
_meta._rate_limits.remaining_dayintegerRemaining requests in the current day window.
| Field | Type | Description |
|---|---|---|
| data.list[] | array | Vault categories on this page. |
| data.list[].id | integer | Vault list ID. Pass as the list filter on List Vault Media. |
| data.list[].type | string | One of stories, streams, media_stickers, posts, messages, custom. |
| data.list[].name | string | Display name. Custom folders use the creator-chosen name. |
| data.list[].canUpdate | boolean | true for custom folders that can be renamed; false for system lists. |
| data.list[].canDelete | boolean | true for custom folders that can be deleted; false for system lists. |
| data.list[].videosCount | integer | Number of videos in the list. |
| data.list[].photosCount | integer | Number of photos in the list. |
| data.list[].gifsCount | integer | Number of GIFs in the list. |
| data.list[].audiosCount | integer | Number of audio items in the list. |
| data.list[].medias | array | Small preview strip of items — used for UI thumbnails. |
| data.all | object | Aggregate counts across every list (videosCount, photosCount, gifsCount, audiosCount). |
| data.canCreateVaultLists | boolean | Whether the account can create new custom folders. |
| 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/vault/lists?limit=20&offset=0&query=creator" \
--header "Authorization: Bearer YOUR_API_KEY"Response
200