OnlyFans API
Collections user lists

Get User Lists

Get a list of OnlyFans Collections - User Lists

GET
/api/{account}/user-lists
AuthorizationBearer <token>

Get your API Key from OnlyFansAPI Console - https://app.onlyfansapi.com/api-keys

In: header

Path Parameters

accountstring

The Account ID

Query Parameters

limit?integer | null

How many results to return in the request. Max. 50 user lists. Must be at least 10. Must not be greater than 50.

offset?integer | null

Must be at least 0.

Response Body

curl -X GET "https://app.onlyfansapi.com/api/string/user-lists?limit=10&offset=0"
{
  "data": [
    {
      "id": "recent",
      "type": "recent",
      "name": "Recent (last 24 hours)",
      "usersCount": 0,
      "postsCount": 362,
      "order": "default",
      "direction": "asc",
      "canUpdate": false,
      "canDelete": false,
      "canManageUsers": false,
      "canAddUsers": false,
      "canPinnedToFeed": false,
      "isPinnedToFeed": false,
      "canPinnedToChat": false,
      "isPinnedToChat": false,
      "sortList": [],
      "users": []
    },
    {
      "id": "following",
      "type": "following",
      "name": "Following",
      "usersCount": 1565,
      "postsCount": 302925,
      "order": "last_activity",
      "direction": "desc",
      "canUpdate": false,
      "canDelete": false,
      "canManageUsers": false,
      "canAddUsers": false,
      "canPinnedToFeed": false,
      "isPinnedToFeed": false,
      "canPinnedToChat": true,
      "isPinnedToChat": false,
      "sortList": {
        "expired": {
          "order": "is_expired",
          "direction": "desc"
        }
      },
      "users": [
        {
          "view": "t",
          "id": 13760776,
          "name": "User 1",
          "username": "user001",
          "isVerified": true,
          "avatar": null,
          "avatarThumbs": null
        },
        {
          "view": "t",
          "id": 20385509,
          "name": "User 2",
          "username": "user002",
          "isVerified": true,
          "avatar": null,
          "avatarThumbs": null
        },
        {
          "view": "t",
          "id": 21272634,
          "name": "User 3",
          "username": "user003",
          "isVerified": true,
          "avatar": null,
          "avatarThumbs": null
        }
      ]
    },
    {
      "id": 1139401260,
      "type": "custom",
      "name": "Test List",
      "usersCount": 7,
      "postsCount": 0,
      "order": "default",
      "direction": "asc",
      "canUpdate": true,
      "canDelete": true,
      "canManageUsers": true,
      "canAddUsers": true,
      "canPinnedToFeed": true,
      "isPinnedToFeed": false,
      "canPinnedToChat": true,
      "isPinnedToChat": false,
      "sortList": [],
      "users": [
        {
          "view": "t",
          "id": 90986491,
          "name": "User 4",
          "username": "user004",
          "isVerified": false,
          "avatar": "https://example.com/avatar1.jpg",
          "avatarThumbs": {
            "c50": "https://example.com/avatar1_c50.jpg",
            "c144": "https://example.com/avatar1_c144.jpg"
          }
        },
        {
          "view": "t",
          "id": 179686216,
          "name": "User 5",
          "username": "user005",
          "isVerified": false,
          "avatar": null,
          "avatarThumbs": null
        },
        {
          "view": "t",
          "id": 215265232,
          "name": "User 6",
          "username": "user006",
          "isVerified": false,
          "avatar": null,
          "avatarThumbs": null
        }
      ]
    },
    {
      "id": 1015359034,
      "type": "custom",
      "name": "Sample List",
      "usersCount": 1,
      "postsCount": 29,
      "order": "default",
      "direction": "asc",
      "canUpdate": true,
      "canDelete": true,
      "canManageUsers": true,
      "canAddUsers": true,
      "canPinnedToFeed": true,
      "isPinnedToFeed": false,
      "canPinnedToChat": true,
      "isPinnedToChat": false,
      "sortList": [],
      "users": [
        {
          "view": "t",
          "id": 254,
          "name": "Official Account",
          "username": "official_account",
          "isVerified": true,
          "avatar": "https://example.com/official_avatar.jpg",
          "avatarThumbs": {
            "c50": "https://example.com/official_avatar_c50.jpg",
            "c144": "https://example.com/official_avatar_c144.jpg"
          }
        }
      ]
    },
    {
      "id": 1196977344,
      "type": "custom",
      "name": "Custom List 1",
      "usersCount": 3,
      "postsCount": 10,
      "order": "default",
      "direction": "asc",
      "canUpdate": true,
      "canDelete": true,
      "canManageUsers": true,
      "canAddUsers": true,
      "canPinnedToFeed": true,
      "isPinnedToFeed": false,
      "canPinnedToChat": true,
      "isPinnedToChat": false,
      "sortList": [],
      "users": [
        {
          "view": "t",
          "id": 501222911,
          "name": "User 7",
          "username": "user007",
          "isVerified": true,
          "avatar": "https://example.com/avatar2.jpg",
          "avatarThumbs": {
            "c50": "https://example.com/avatar2_c50.jpg",
            "c144": "https://example.com/avatar2_c144.jpg"
          }
        },
        {
          "view": "t",
          "id": 501239164,
          "name": "User 8",
          "username": "user008",
          "isVerified": true,
          "avatar": null,
          "avatarThumbs": null
        },
        {
          "view": "t",
          "id": 501239274,
          "name": "User 9",
          "username": "user009",
          "isVerified": true,
          "avatar": "https://example.com/avatar3.jpg",
          "avatarThumbs": {
            "c50": "https://example.com/avatar3_c50.jpg",
            "c144": "https://example.com/avatar3_c144.jpg"
          }
        }
      ]
    },
    {
      "id": 1030408500,
      "type": "custom",
      "name": "Custom List 2",
      "usersCount": 3,
      "postsCount": 253,
      "order": "default",
      "direction": "asc",
      "canUpdate": true,
      "canDelete": true,
      "canManageUsers": true,
      "canAddUsers": true,
      "canPinnedToFeed": true,
      "isPinnedToFeed": false,
      "canPinnedToChat": true,
      "isPinnedToChat": false,
      "sortList": [],
      "users": [
        {
          "view": "t",
          "id": 11317639,
          "name": "User 10",
          "username": "user010",
          "isVerified": false,
          "avatar": null,
          "avatarThumbs": null
        },
        {
          "view": "t",
          "id": 333848388,
          "name": "User 11",
          "username": "user011",
          "isVerified": false,
          "avatar": null,
          "avatarThumbs": null
        },
        {
          "view": "t",
          "id": 343871698,
          "name": "User 12",
          "username": "user012",
          "isVerified": true,
          "avatar": "https://example.com/avatar4.jpg",
          "avatarThumbs": {
            "c50": "https://example.com/avatar4_c50.jpg",
            "c144": "https://example.com/avatar4_c144.jpg"
          }
        }
      ]
    },
    {
      "id": 1197226753,
      "type": "custom",
      "name": "Custom List 3",
      "usersCount": 3,
      "postsCount": 2,
      "order": "default",
      "direction": "asc",
      "canUpdate": true,
      "canDelete": true,
      "canManageUsers": true,
      "canAddUsers": true,
      "canPinnedToFeed": true,
      "isPinnedToFeed": false,
      "canPinnedToChat": true,
      "isPinnedToChat": false,
      "sortList": [],
      "users": [
        {
          "view": "t",
          "id": 501239695,
          "name": "User 13",
          "username": "user013",
          "isVerified": true,
          "avatar": "https://example.com/avatar5.jpg",
          "avatarThumbs": {
            "c50": "https://example.com/avatar5_c50.jpg",
            "c144": "https://example.com/avatar5_c144.jpg"
          }
        },
        {
          "view": "t",
          "id": 501239827,
          "name": "User 14",
          "username": "user014",
          "isVerified": true,
          "avatar": "https://example.com/avatar6.jpg",
          "avatarThumbs": {
            "c50": "https://example.com/avatar6_c50.jpg",
            "c144": "https://example.com/avatar6_c144.jpg"
          }
        },
        {
          "view": "t",
          "id": 501240489,
          "name": "User 15",
          "username": "user015",
          "isVerified": true,
          "avatar": "https://example.com/avatar7.jpg",
          "avatarThumbs": {
            "c50": "https://example.com/avatar7_c50.jpg",
            "c144": "https://example.com/avatar7_c144.jpg"
          }
        }
      ]
    },
    {
      "id": 1197228713,
      "type": "custom",
      "name": "Empty List",
      "usersCount": 0,
      "postsCount": 0,
      "order": "default",
      "direction": "asc",
      "canUpdate": true,
      "canDelete": true,
      "canManageUsers": true,
      "canAddUsers": true,
      "canPinnedToFeed": true,
      "isPinnedToFeed": false,
      "canPinnedToChat": true,
      "isPinnedToChat": false,
      "sortList": [],
      "users": []
    },
    {
      "id": 1015361366,
      "type": "custom",
      "name": "Custom List 4",
      "usersCount": 4,
      "postsCount": 0,
      "order": "default",
      "direction": "asc",
      "canUpdate": true,
      "canDelete": true,
      "canManageUsers": true,
      "canAddUsers": true,
      "canPinnedToFeed": true,
      "isPinnedToFeed": false,
      "canPinnedToChat": true,
      "isPinnedToChat": false,
      "sortList": [],
      "users": [
        {
          "view": "t",
          "id": 234451987,
          "name": "User 16",
          "username": "user016",
          "isVerified": false,
          "avatar": "https://example.com/avatar8.jpg",
          "avatarThumbs": {
            "c50": "https://example.com/avatar8_c50.jpg",
            "c144": "https://example.com/avatar8_c144.jpg"
          }
        },
        {
          "view": "t",
          "id": 240164795,
          "name": "User 17",
          "username": "user017",
          "isVerified": false,
          "avatar": "https://example.com/avatar9.jpg",
          "avatarThumbs": {
            "c50": "https://example.com/avatar9_c50.jpg",
            "c144": "https://example.com/avatar9_c144.jpg"
          }
        },
        {
          "view": "t",
          "id": 279118217,
          "name": "User 18",
          "username": "user018",
          "isVerified": false,
          "avatar": null,
          "avatarThumbs": null
        }
      ]
    },
    {
      "id": 1015359887,
      "type": "custom",
      "name": "Another Empty List",
      "usersCount": 0,
      "postsCount": 0,
      "order": "default",
      "direction": "asc",
      "canUpdate": true,
      "canDelete": true,
      "canManageUsers": true,
      "canAddUsers": true,
      "canPinnedToFeed": true,
      "isPinnedToFeed": false,
      "canPinnedToChat": true,
      "isPinnedToChat": false,
      "sortList": [],
      "users": []
    }
  ],
  "_meta": {
    "_credits": {
      "used": 1,
      "balance": 224858,
      "note": "Always"
    },
    "_cache": {
      "is_cached": false,
      "note": "Cache disabled for this endpoint"
    },
    "_rate_limits": {
      "limit_minute": 1000,
      "limit_day": 50000,
      "remaining_minute": 998,
      "remaining_day": 49991
    }
  }
}