Comment Object

idinteger<int32>

Unique id of the comment.

Example: 2

game_idinteger<int32>

Unique game id (if applicable).

Example: 2

mod_idinteger<int32>

Deprecated: Please use resource_id instead, this will be removed in subsequent API version.

Example: 2

resource_idinteger<int32>

Unique id of the parent resource.

Example: 2

resource_ownershipinteger<int32>

Bitwise value of the user who published the comment.

Default value: 2

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

date_addedinteger<int32>

Unix timestamp of date the comment was posted.

Example: 1499841487

reply_idinteger<int32>

Id of the parent comment this comment is replying to (can be 0 if the comment is not a reply).

Example: 0

thread_positionstring

Levels of nesting in a comment thread. How it works:

- The first comment will have the position '01'.
- The second comment will have the position '02'.
- If someone responds to the second comment the position will be '02.01'.
- A maximum of 3 levels is supported.

Example: 01

karmainteger<int32>

Karma received for the comment (can be postive or negative).

Example: 1

karma_guestinteger<int32>

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

Example: 0

contentstringrequired

Contents of the comment.

Example: Hey <a href="https://mod.io/u/guest">guest</a>, you should check out this mod!

optionsComment Option Enum (integer)

Enum Value	Description
NONE (0)	All of the options below are disabled
PINNED (1)	Pinned comment
LOCKED (2)	Locked comment

Possible values: [0, 1, 2, 4]

Comment Object

{
  "id": 2,
  "game_id": 2,
  "mod_id": 2,
  "resource_id": 2,
  "resource_ownership": 2,
  "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"
  },
  "date_added": 1499841487,
  "reply_id": 0,
  "thread_position": "01",
  "karma": 1,
  "karma_guest": 0,
  "content": "Hey <a href=\"https://mod.io/u/guest\">guest</a>, you should check out this mod!",
  "options": 0
}