Skip to content

File Download Users

  • Endpoint Path: /api/v2/common/file/{fid}/users
  • Method: GET
  • Request: Rest + Query

Headers Optional Parameter

Parameter NamePublic Mode (Required)Private Mode (Required)
X-Fresns-Aidrequiredrequired
X-Fresns-Aid-Tokenrequiredrequired
X-Fresns-Uidrequiredrequired
X-Fresns-Uid-Tokenrequiredrequired

Rest Params

Parameter NameTypeRequiredDescription
fidStringrequiredFile to download

Query Params

Parameter NameTypeRequiredDescription
whitelistKeysStringoptionalWhitelist key names, only returns key-value pairs for the given key names
Multiple separated by English commas, supports "dot notation" for multi-dimensional arrays
blacklistKeysStringoptionalBlacklist key names, removes specified key-value pairs from the returned data
Multiple separated by English commas, supports "dot notation" for multi-dimensional arrays
pageSizeNumberoptionalNumber of items per page (default 15 items)
pageNumberoptionalPage number (default 1)

Return

json
{
    "code": 0,
    "message": "ok",
    "data": {
        "pagination": {
            "total": "Number / How much data in total",
            "pageSize": "Number / How much data on each page",
            "currentPage": "Number / Current page number",
            "lastPage": "Number / Last page number"
        },
        "list": [
            {
                "datetime": "String / Download time",
                "timeAgo": "String / Humanized download time",
                "user": {
                    // Common Data Structure -> User Info
                }
            }
        ]
    }
}

Released under the Apache-2.0 License