Skip to main content

Mod User Preview Object

Contains avatar data.

user object

Contains user data.

idinteger<int32>

Unique id of the user.

Example: 1
name_idstring

Path for the user on mod.io. For example: https://mod.io/u/__name-id-here__

Example: xant
usernamestring

Display name of the user.

Example: XanT
display_name_portalstring

The users' display name for the targeted portal. Value will be null if no valid X-Modio-Portal portal header value is provided. For more information see Targeting a Portal.

Example: null
date_onlineinteger<int32>

Unix timestamp of date the user was last online.

Example: 1509922961
date_joinedinteger<int32>

Unix timestamp of date the user joined.

Example: 1509922961
avatar object

Contains avatar data.

filenamestring

Avatar filename including extension.

Example: avatar.png
originalstring

URL to the full-sized avatar.

Example: https://assets.modcdn.io/images/placeholder/avatar.png
thumb_50x50string

URL to the small avatar thumbnail.

Example: https://assets.modcdn.io/images/placeholder/avatar_50x50.png
thumb_100x100string

URL to the medium avatar thumbnail.

Example: https://assets.modcdn.io/images/placeholder/avatar_100x100.png
timezonestring

Deprecated: No longer used and will be removed in subsequent API version.

Example:
languagestring

Deprecated: No longer used and will be removed in subsequent API version. To localize the API response we recommend you set the Accept-Language header.

Example:
profile_urlstring

URL to the users profile.

Example: https://mod.io/u/xant
user_from object

Contains user data.

idinteger<int32>

Unique id of the user.

Example: 1
name_idstring

Path for the user on mod.io. For example: https://mod.io/u/__name-id-here__

Example: xant
usernamestring

Display name of the user.

Example: XanT
display_name_portalstring

The users' display name for the targeted portal. Value will be null if no valid X-Modio-Portal portal header value is provided. For more information see Targeting a Portal.

Example: null
date_onlineinteger<int32>

Unix timestamp of date the user was last online.

Example: 1509922961
date_joinedinteger<int32>

Unix timestamp of date the user joined.

Example: 1509922961
avatar object

Contains avatar data.

filenamestring

Avatar filename including extension.

Example: avatar.png
originalstring

URL to the full-sized avatar.

Example: https://assets.modcdn.io/images/placeholder/avatar.png
thumb_50x50string

URL to the small avatar thumbnail.

Example: https://assets.modcdn.io/images/placeholder/avatar_50x50.png
thumb_100x100string

URL to the medium avatar thumbnail.

Example: https://assets.modcdn.io/images/placeholder/avatar_100x100.png
timezonestring

Deprecated: No longer used and will be removed in subsequent API version.

Example:
languagestring

Deprecated: No longer used and will be removed in subsequent API version. To localize the API response we recommend you set the Accept-Language header.

Example:
profile_urlstring

URL to the users profile.

Example: https://mod.io/u/xant
resource_urlstring

The URL of the resource that the registrant should be redirect to upon success.

Example: https://mod.io/g/@rogueknight/m/@some-mod
subscribedboolean

If the user is also subscribed to the resource.

Example: false
date_addedinteger<int32>

Unix timestamp of the date the user was registered as a previewer.

Example: 1499841487
Mod User Preview Object
{
  "user": {
    "id": 1,
    "name_id": "xant",
    "username": "XanT",
    "display_name_portal": null,
    "date_online": 1509922961,
    "date_joined": 1509922961,
    "avatar": {
      "filename": "avatar.png",
      "original": "https://assets.modcdn.io/images/placeholder/avatar.png",
      "thumb_50x50": "https://assets.modcdn.io/images/placeholder/avatar_50x50.png",
      "thumb_100x100": "https://assets.modcdn.io/images/placeholder/avatar_100x100.png"
    },
    "timezone": "",
    "language": "",
    "profile_url": "https://mod.io/u/xant"
  },
  "user_from": {
    "id": 1,
    "name_id": "xant",
    "username": "XanT",
    "display_name_portal": null,
    "date_online": 1509922961,
    "date_joined": 1509922961,
    "avatar": {
      "filename": "avatar.png",
      "original": "https://assets.modcdn.io/images/placeholder/avatar.png",
      "thumb_50x50": "https://assets.modcdn.io/images/placeholder/avatar_50x50.png",
      "thumb_100x100": "https://assets.modcdn.io/images/placeholder/avatar_100x100.png"
    },
    "timezone": "",
    "language": "",
    "profile_url": "https://mod.io/u/xant"
  },
  "resource_url": "https://mod.io/g/@rogueknight/m/@some-mod",
  "subscribed": false,
  "date_added": 1499841487
}