Skip to content

User Detail

  • Endpoint Path: /api/fresns/v1/user/{uidOrUsername}/detail
  • Method: GET
  • Request: Rest

Headers Optional Parameter

KeyPublic Mode (Required)Private Mode (Required)
X-Fresns-Aidoptionalrequired
X-Fresns-Aid-Tokenoptionalrequired
X-Fresns-Uidoptionalrequired
X-Fresns-Uid-Tokenoptionalrequired

Path Variables

KeyTypeRequiredDescription
uidOrUsernameNumber / StringrequiredUser uid or username

Query Params

KeyTypeRequiredDescription
filterTypeStringoptionalwhitelist only returns key-value pairs for the given key names
blacklist removes specified key-value pairs from the returned data
filterKeysStringoptionalMultiple separated by English commas, supports "dot notation" for multi-dimensional arrays

Return

json
{
    "code": 0,
    "message": "ok",
    "data": {
        "items": {
            "title": "String / SEO Title",
            "keywords": "String / SEO Keywords",
            "description": "String / SEO Description",
            "manages": [
                {
                    // User manage extensions
                    // Common Data Structure -> Extend Function Info
                }
            ],
        },
        "detail": {
            // Common Data Structure -> User Info
        }
    }
}

Released under the Apache-2.0 License