Skip to main content

Mod Collection Object

idinteger<int32>

The collection id.

Example: 1
game_idinteger<int32>

The game id.

Example: 101
statusinteger<int32>

The status of the collection.

Example: 1
visibleboolean

Visibility status of the collection.

Example: true
submitted_by 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
categorystring

The category of the collection.

Example: Action
date_addedinteger<int32>

The date the collection was added.

Example: 1633036800
date_updatedinteger<int32>

The date the collection was last updated.

Example: 1633123200
date_liveinteger<int32>

The date the collection went live.

Example: 1633209600
date_disabledinteger<int32>

The date the collection was disabled.

Example: 163330000
limit_number_modsinteger<int32>

The maximum limit of mods allowed in this collection.

Example: 10
maturity_optionCollection Maturity Enum (integer)

Mature content found in a collection.

NOTE: The value of this field will default to 0 unless the parent game allows you to flag mature content (see maturity_options field in Game Object). Add the options you want together, to enable multiple options (see BITWISE fields)

Enum ValueDescription
NONE (0)None
ALCOHOL (1)Alcohol
DRUGS (2)Drugs
VIOLENT (4)Violence
EXPLICIT (8)Explicit

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

Default value: 0
filesizeinteger<int32>

The total filesize of all mods in the collection.

Example: 2048
filesize_uncompressedinteger<int32>

The total uncompressed filesize of all mods in the collection.

Example: 2048
platformsPlatform String Enum (string)[]

The platforms the mods are compatible within this collection.

Possible values: [ALL, WINDOWS, MAC, LINUX, ANDROID, IOS, XBOXONE, XBOXSERIESX, PLAYSTATION4, PLAYSTATION5, SWITCH, OCULUS, SOURCE]

Example: ["windows","ps4"]
tagsCollection Tag Enum (string)[]

The tags associated with the collection.

Possible values: [ANIMATION, AUDIO, BUGFIXES, CHEATING, ENVIRONMENT, GAMEPLAY, QUALITY_OF_LIFE, UI, VISUAL]

Example: ["Multiplayer","Adventure"]
stats object
collection_idinteger<int32>

The collection id.

Example: 123
downloads_todayinteger<int32>

The number of downloads today.

Example: 50
downloads_uniqueinteger<int32>

The number of unique downloads.

Example: 200
downloads_totalinteger<int32>

The total number of downloads.

Example: 1000
followers_totalinteger<int32>

The total number of followers.

Example: 300
ratings_positive_30_daysinteger<int32>

The number of positive ratings in the last 30 days.

Example: 25
logo object

Contains logo data.

filenamestring

Logo filename including extension.

Example: card.png
originalstring

URL to the full-sized logo.

Example: https://assets.modcdn.io/images/placeholder/card.png
thumb_320x180string

URL to the small logo thumbnail.

Example: https://assets.modcdn.io/images/placeholder/card.png
thumb_640x360string

URL to the medium logo thumbnail.

Example: https://assets.modcdn.io/images/placeholder/card.png
thumb_1280x720string

URL to the large logo thumbnail.

Example: https://assets.modcdn.io/images/placeholder/card.png
namestring

The name of the collection.

Example: My Collection
name_idstring

The name id of the collection.

Example: my-collection
summarystring

The summary of the collection.

Example: This is a summary of the collection.
descriptionstring

The description of the collection.

Example: This is a detailed description of the collection.
Mod Collection Object
{
  "id": 1,
  "game_id": 101,
  "status": 1,
  "visible": true,
  "submitted_by": {
    "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"
  },
  "category": "Action",
  "date_added": 1633036800,
  "date_updated": 1633123200,
  "date_live": 1633209600,
  "date_disabled": 163330000,
  "limit_number_mods": 10,
  "maturity_option": 0,
  "filesize": 2048,
  "filesize_uncompressed": 2048,
  "platforms": [
    "windows",
    "ps4"
  ],
  "tags": [
    "Multiplayer",
    "Adventure"
  ],
  "stats": {
    "collection_id": 123,
    "downloads_today": 50,
    "downloads_unique": 200,
    "downloads_total": 1000,
    "followers_total": 300,
    "ratings_positive_30_days": 25
  },
  "logo": {
    "filename": "card.png",
    "original": "https://assets.modcdn.io/images/placeholder/card.png",
    "thumb_320x180": "https://assets.modcdn.io/images/placeholder/card.png",
    "thumb_640x360": "https://assets.modcdn.io/images/placeholder/card.png",
    "thumb_1280x720": "https://assets.modcdn.io/images/placeholder/card.png"
  },
  "name": "My Collection",
  "name_id": "my-collection",
  "summary": "This is a summary of the collection.",
  "description": "This is a detailed description of the collection."
}