Skip to content

response_schemas

Jump to bottom
YYBartT edited this page Jun 15, 2023 · 1 revision

Response Schemas

This page lists all possible data types.

When you call one of the mod.io extension functions, you pass a success callback function to it as the first parameter. This callback function is called by GameMaker and passes the mod.io response to it as the response argument.

  • result_count Number of results returned in this request.
  • result_offset Number of results skipped over. Defaults to 0 unless overridden by _offset filter.
  • result_limit Maximum number of results returned in the request. Defaults to 100 (max) unless overridden by _limit filter.
  • result_total Total number of results found.

The actual data is always returned in the data attribute.

Structs

This module offers a collection of structs, which serve as custom data models for organizing and structuring data. Explore the provided structs to better understand the relationships between data elements and simplify your data manipulation tasks.


Back To Top

AccessToken

mod.io Response Schema: Access Token Object

This struct is referenced by the following functions:


Member Type Description
code Real HTTP Response Code.
access_token String The user's access token.
date_expires Real The Unix timestamp of the date this token will expire. Default is one year from issue date. See Access Token Lifetime & Expiry.

Back To Top

AgreementVersion

mod.io Response Schema: Agreement Version Object

This struct is referenced by the following functions:


Member Type Description
id Real Unique id of the agreement.
is_active Boolean Is the agreement currently active? (This can also be determined if date_live > 0).
type Real The type of agreement. Can be one of the following:

1 = Terms
2 = Privacy
3 = Developers
4 = API
5 = Payment
6 = AUP
user User No description
date_added Real Unix timestamp of the date the agreement was added.
date_updated Real Unix timestamp of the date the agreement was updated.
date_live Real Unix timestamp of the date the agreement was set live.
name String Name of the agreement.
changelog String Changelog for version of this agreement.
description String The contents of the agreement

Back To Top

Avatar

mod.io Response Schema: Avatar Object

This struct is referenced by the following structs:


Member Type Description
filename String Avatar filename including extension.
original String URL to the full-sized avatar.
thumb_50x50 String URL to the small avatar thumbnail.
thumb_100x100 String URL to the medium avatar thumbnail.

Back To Top

Comment

mod.io Response Schema: Comment Object

This struct is referenced by the following functions:

This struct is referenced by the following structs:


Member Type Description
id Real Unique id of the comment.
game_id Real Unique game id (if applicable).
resource_id Real Unique id of the parent resource.
The User user who published the comment.
date_added Real Unix timestamp of date the comment was posted.
reply_id Real Id of the parent comment this comment is replying to (can be 0 if the comment is not a reply).
thread_position String 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.
karma Real Karma received for the comment (can be positive or negative).
content String Contents of the comment.

Back To Top

Download

mod.io Response Schema: Download Object

This struct is referenced by the following structs:


Member Type Description
binary_url String The URL to download the file from the mod.io CDN.

> ℹ️ NOTE
>
> If the game requires mod downloads to be initiated via the API, the binary_url returned will contain a verification hash. This hash must be supplied to get the modfile, and will expire after a certain period of time. Saving and reusing the binary_url won't work in this situation given its dynamic nature.
date_expires Real Unix timestamp of when the binary_url will expire.

Back To Top

Filehash

mod.io Response Schema: Filehash Object

This struct is referenced by the following structs:


Member Type Description
md5 String MD5 hash of the file.

Back To Top

Game

mod.io Response Schema: Game Object

This struct is referenced by the following structs:


Member Type Description
id Real Unique game id.
status Real Status of the game (see status and visibility for details):

0 = Not Accepted
1 = Accepted
3 = Deleted
date_added Real Unix timestamp of date game was registered.
date_updated Real Unix timestamp of date game was updated.
date_live Real Unix timestamp of date game was set live.
presentation_option Real Presentation style used on the mod.io website:

0 = Grid View: Displays mods in a grid
1 = Table View: Displays mods in a table
submission_option Real Submission process modders must follow:

0 = Mod uploads must occur via the API using a tool created by the game developers
1 = Mod uploads can occur from anywhere, including the website and API
curation_option Real Curation process used to approve mods:

0 = No curation: Mods are immediately available to play
2 = Full curation: All mods must be accepted by someone to be listed
community_options Real Community features enabled for this game:

0 = All of the options below are disabled
1 = Enable comments
2 = Enable guides
4 = Pin on homepage
8 = Show on homepage
16 = Show more on homepage
32 = Allow change status
? = Add the options you want together, to enable multiple features (see BITWISE fields)
monetisation_options Real Monetisation features mods can enable:

0 = All of the options below are disabled
1 = Enabled
2 = Enable recognition
4 = Enable marketplace
? = Add the options you want together, to enable multiple features (see BITWISE fields)
revenue_options Real Deprecated: Please use monetisation_options instead, this will be removed in subsequent API version.
api_access_options Real Level of API access allowed by this game:

0 = All of the options below are disabled
1 = Allow 3rd parties to access this games API endpoints
2 = Allow mods to be downloaded directly (if disabled all download URLs will contain a frequently changing verification hash to stop unauthorized use)
? = Add the options you want together, to enable multiple features (see BITWISE fields)
maturity_options Real Mature content setup for this game:

0 = Don't allow mature content in mods
1 = Allow mature content in mods
2 = This game is for mature audiences only
? = Add the options you want together, to enable multiple features (see BITWISE fields)
ugc_name String Word used to describe user-generated content (mods, items, addons etc).
icon Icon Contains media URL's to the icon for the game.
logo Logo Contains media URL's to the logo for the game.
header HeaderImage Contains media URL's to the preview header for the game.
name String Name of the game.
name_id String Path for the game on mod.io. For example: https://mod.io/g/rogue-knight
summary String Summary of the games mod support.
instructions String A guide about creating and uploading mods for this game to mod.io (applicable if submission_option = 0).
instructions_url String Link to a mod.io guide, your modding wiki or a page where modders can learn how to make and submit mods to your games profile.
profile_url String URL to the game.
stats GameStats Numerous aggregate stats for the game.
theme Theme Theme color values for the game.
other_urls GameOtherUrls Creator defined URLs to share.
tag_options GameTagOption Groups of tags configured by the game developer, that mods can select. Hidden tags will only be returned if show_hidden_tags is set to true.
platforms GamePlatforms Platforms that are supported by this title.

Back To Top

GameOtherUrls

GameOtherUrls struct

This struct is referenced by the following structs:


Member Type Description
label String Label of the link you are sharing.
url String The URL to be associated with the label.

Back To Top

GamePlatforms

GamePlatforms struct

This struct is referenced by the following structs:


Member Type Description
platform String A target platform.
label String A presentable label of the platform.
moderated Boolean Is this platform moderated by game admins? If false, then user submissions for the platform will be available immediately providing the game has mod curation disabled.

Back To Top

GameStats

mod.io Response Schema: Game Stats Object

This struct is referenced by the following functions:

This struct is referenced by the following structs:


Member Type Description
game_id Real Unique game id.
mods_count_total Real Available mod count for the game.
mods_downloads_today Real Mods downloaded today for the game.
mods_downloads_total Real Total Mods downloaded for the game.
mods_downloads_daily_average Real Average mods downloaded on a daily basis.
mods_subscribers_total Real Number of total users who have subscribed to the mods for the game.
date_expires Real Unix timestamp until this game's statistics are considered stale.

Back To Top

GameTagOption

mod.io Response Schema: Game Tag Option Object

This struct is referenced by the following structs:


Member Type Description
name String Name of the tag group.
type String Can multiple tags be selected via 'checkboxes' or should only a single tag be selected via a 'dropdown'.
tag_count_map Struct List of tag names and the count of mods with these tags.
hidden Boolean Groups of tags flagged as 'hidden' are intended to be used for filtering (eg. game version), but should not be displayed to users. Hidden tags will only be returned if show_hidden_tags is set to true.
locked Boolean Groups of tags flagged as 'locked' are editable only if the authenticated user is a team member of the parent game. Useful for games to tag special functionality, which users can see and filter on (eg. competition winners).
tags Array of String Array of tags in this group.

Back To Top

GetGameTagOptions

mod.io Response Schema: Get Game Tag Options

This struct is referenced by the following functions:


Member Type Description
data Array of GameTagOption Array containing game tag structs.
result_count Real Number of results returned in this request.
result_offset Real Number of results skipped over. Defaults to 0 unless overridden by offset filter.
result_limit Real Maximum number of results returned in the request. Defaults to 100 (max) unless overridden by limit filter.
result_total Real Total number of results found.

Back To Top

GetGames

mod.io Response Schema: Get Games

This struct is referenced by the following functions:


Member Type Description
data Array of Game Array containing game structs.
result_count Real Number of results returned in this request.
result_offset Real Number of results skipped over. Defaults to 0 unless overridden by offset filter.
result_limit Real Maximum number of results returned in the request. Defaults to 100 (max) unless overridden by limit filter.
result_total Real Total number of results found.

Back To Top

GetGuideComments

mod.io Response Schema: Get Guide Comments


Member Type Description
data Array of Comment Array containing comment structs.
result_count Real Number of results returned in this request.
result_offset Real Number of results skipped over. Defaults to 0 unless overridden by offset filter.
result_limit Real Maximum number of results returned in the request. Defaults to 100 (max) unless overridden by limit filter.
result_total Real Total number of results found.

Back To Top

GetModComments

mod.io Response Schema: Get Mod Comments

This struct is referenced by the following functions:


Member Type Description
data Array of Comment Array containing comment structs.
result_count Real Number of results returned in this request.
result_offset Real Number of results skipped over. Defaults to 0 unless overridden by offset filter.
result_limit Real Maximum number of results returned in the request. Defaults to 100 (max) unless overridden by limit filter.
result_total Real Total number of results found.

Back To Top

GetModDependencies

mod.io Response Schema: Get Mod Dependencies

This struct is referenced by the following functions:


Member Type Description
data Array of ModDependencies Array containing mod dependencies structs.
result_count Real Number of results returned in this request.
result_offset Real Number of results skipped over. Defaults to 0 unless overridden by offset filter.
result_limit Real Maximum number of results returned in the request. Defaults to 100 (max) unless overridden by limit filter.
result_total Real Total number of results found.

Back To Top

GetModEvents

mod.io Response Schema: Get Mod Events

This struct is referenced by the following functions:


Member Type Description
data Array of ModEvent Array containing mod event structs.
result_count Real Number of results returned in this request.
result_offset Real Number of results skipped over. Defaults to 0 unless overridden by offset filter.
result_limit Real Maximum number of results returned in the request. Defaults to 100 (max) unless overridden by limit filter.
result_total Real Total number of results found.

Back To Top

GetModKVPMetadata

mod.io Response Schema: Get Mod KVP Metadata


Member Type Description
data Array of MetadataKVP Array containing metadata KVP structs.
result_count Real Number of results returned in this request.
result_offset Real Number of results skipped over. Defaults to 0 unless overridden by offset filter.
result_limit Real Maximum number of results returned in the request. Defaults to 100 (max) unless overridden by limit filter.
result_total Real Total number of results found.

Back To Top

GetModStats

mod.io Response Schema: Get Mod Stats

This struct is referenced by the following functions:


Member Type Description
data Array of ModStats Array containing stats structs.
result_count Real Number of results returned in this request.
result_offset Real Number of results skipped over. Defaults to 0 unless overridden by offset filter.
result_limit Real Maximum number of results returned in the request. Defaults to 100 (max) unless overridden by limit filter.
result_total Real Total number of results found.

Back To Top

GetModTags

mod.io Response Schema: Get Mod Tags

This struct is referenced by the following functions:


Member Type Description
data Array of ModTag Array containing mod tag structs.
result_count Real Number of results returned in this request.
result_offset Real Number of results skipped over. Defaults to 0 unless overridden by offset filter.
result_limit Real Maximum number of results returned in the request. Defaults to 100 (max) unless overridden by limit filter.
result_total Real Total number of results found.

Back To Top

GetModfiles

mod.io Response Schema: Get Modfiles

This struct is referenced by the following functions:


Member Type Description
data Array of Modfile Array containing modfile structs.
result_count Real Number of results returned in this request.
result_offset Real Number of results skipped over. Defaults to 0 unless overridden by offset filter.
result_limit Real Maximum number of results returned in the request. Defaults to 100 (max) unless overridden by limit filter.
result_total Real Total number of results found.

Back To Top

GetMods

mod.io Response Schema: Get Mods

This struct is referenced by the following functions:


Member Type Description
data Array of Mod Array containing mod structs.
result_count Real Number of results returned in this request.
result_offset Real Number of results skipped over. Defaults to 0 unless overridden by offset filter.
result_limit Real Maximum number of results returned in the request. Defaults to 100 (max) unless overridden by limit filter.
result_total Real Total number of results found.

Back To Top

GetMutedUsers

mod.io Response Schema: Get Muted Users

This struct is referenced by the following functions:


Member Type Description
data Array of User Array containing user structs.
result_count Real Number of results returned in this request.
result_offset Real Number of results skipped over. Defaults to 0 unless overridden by offset filter.
result_limit Real Maximum number of results returned in the request. Defaults to 100 (max) unless overridden by limit filter.
result_total Real Total number of results found.

Back To Top

GetTeamMembers

mod.io Response Schema: Get Team Members

This struct is referenced by the following functions:


Member Type Description
data Array of TeamMember Array containing team member structs.
result_count Real Number of results returned in this request.
result_offset Real Number of results skipped over. Defaults to 0 unless overridden by offset filter.
result_limit Real Maximum number of results returned in the request. Defaults to 100 (max) unless overridden by limit filter.
result_total Real Total number of results found.

Back To Top

GetUserEvents

mod.io Response Schema: Get User Events

This struct is referenced by the following functions:


Member Type Description
data Array of UserEvent Array containing user event structs.
result_count Real Number of results returned in this request.
result_offset Real Number of results skipped over. Defaults to 0 unless overridden by offset filter.
result_limit Real Maximum number of results returned in the request. Defaults to 100 (max) unless overridden by limit filter.
result_total Real Total number of results found.

Back To Top

GetUserRatings

mod.io Response Schema: Get User Ratings

This struct is referenced by the following functions:


Member Type Description
data Array of Rating Array containing rating structs.
result_count Real Number of results returned in this request.
result_offset Real Number of results skipped over. Defaults to 0 unless overridden by offset filter.
result_limit Real Maximum number of results returned in the request. Defaults to 100 (max) unless overridden by limit filter.
result_total Real Total number of results found.

Back To Top

HeaderImage

mod.io Response Schema: Header Image Object

This struct is referenced by the following structs:


Member Type Description
filename String Header image filename including extension.
original String URL to the full-sized header image.

Back To Top

Icon

mod.io Response Schema: Icon Object

This struct is referenced by the following structs:


Member Type Description
filename String Icon filename including extension.
original String URL to the full-sized icon.
thumb_64x64 String URL to the small icon thumbnail.
thumb_128x128 String URL to the medium icon thumbnail.
thumb_256x256 String URL to the large icon thumbnail.

Back To Top

Image

mod.io Response Schema: Image Object

This struct is referenced by the following structs:


Member Type Description
filename String Image filename including extension.
original String URL to the full-sized image.
thumb_320x180 String URL to the image thumbnail.
thumb_1280x720 String URL to the image thumbnail.

Back To Top

Logo

mod.io Response Schema: Logo Object

This struct is referenced by the following structs:


Member Type Description
filename String Logo filename including extension.
original String URL to the full-sized logo.
thumb_320x180 String URL to the small logo thumbnail.
thumb_640x360 String URL to the medium logo thumbnail.
thumb_1280x720 String URL to the large logo thumbnail.

Back To Top

Message

mod.io Response Schema: Message Object

This struct is referenced by the following functions:


Member Type Description
code Real HTTP status code of response.
message String The server response to your request. Responses will vary depending on the endpoint, but the object structure will persist.

Back To Top

MetadataKVP

mod.io Response Schema: Metadata KVP Object

This struct is referenced by the following structs:


Member Type Description
metakey String The key of the key-value pair.
metavalue String The value of the key-value pair.

Back To Top

Mod

mod.io Response Schema: Mod Object

This struct is referenced by the following functions:

This struct is referenced by the following structs:


Member Type Description
id Real Unique mod id.
game_id Real Unique game id.
status Real Status of the mod (see status and visibility for details):

0 = Not Accepted
1 = Accepted
3 = Deleted
visible Real Visibility of the mod (see status and visibility for details):

0 = Hidden
1 = Public
submitted_by User The user who published the mod.
date_added Real Unix timestamp of date mod was registered.
date_updated Real Unix timestamp of date mod was updated.
date_live Real Unix timestamp of date mod was set live.
maturity_option Real Maturity options flagged by the mod developer, this is only relevant if the parent game allows mods to be labelled as mature:

0 = None
1 = Alcohol
2 = Drugs
4 = Violence
8 = Explicit
? = Add the options you want together, to enable multiple filters (see BITWISE fields)
community_options Real Community features enabled for this mod:

0 = All of the options below are disabled
1 = Enable comments
? = Add the options you want together, to enable multiple features (see BITWISE fields)
monetisation_options Real Monetisation features enabled for this mod:

0 = All of the options below are disabled
1 = Enabled
2 = Recognition On
4 = Marketplace On
? = Add the options you want together, to enable multiple features (see BITWISE fields)
price Real The price of the mod.
tax Real The tax of the mod.
logo Logo Contains media URL's to the logo for the mod.
homepage_url String Official homepage of the mod.
name String Name of the mod.
name_id String Path for the mod on mod.io. For example: https://mod.io/g/rogue-knight/m/**rogue-knight-hd-pack**
summary String Summary of the mod.
description String Detailed description of the mod which allows HTML.
description_plaintext String description field converted into plaintext.
metadata_blob String Metadata stored by the game developer. Metadata can also be stored as searchable key value pairs, and to individual mod files.
profile_url String URL to the mod.
media ModMedia Contains YouTube & Sketchfab links, aswell as media URL's of images for the mod.
modfile Modfile The primary modfile for the mod.
stats ModStats Numerous aggregate stats for the mod.
platforms ModPlatforms Contains mod platform data.
metadata_kvp MetadataKVP Contains key-value metadata.
tags ModTag Contains mod tag data.

Back To Top

ModDependencies

mod.io Response Schema: Mod Dependencies Object

This struct is referenced by the following structs:


Member Type Description
mod_id Real Unique ID of the mod that serves as the dependency.
name String Name of the mod dependency.
name_id String Path for the mod on mod.io. For example: https://mod.io/g/rogue-knight/m/**rogue-knight-hd-pack**
date_added Real Unix timestamp of date the dependency was added.
dependency_depth Real When a dependency depth is greater than zero (0), it means that the dependencies themselves rely on additional dependencies. To ensure smooth installation, it is recommended dependencies be installed in descending order of depth, beginning with those with the highest depth. Please note only dependencies with a depth of up to 5 will be shown.
logo Logo Contains media URL's to the logo for the mod.
modfile Modfile The primary modfile for the mod.

Back To Top

ModEvents

mod.io Response Schema: Get Mod Events


Member Type Description
data ModEvent Array containing mod event objects.
result_count Real Number of results returned in this request.
result_offset Real Number of results skipped over. Defaults to 0 unless overridden by _offset filter.
result_limit Real Maximum number of results returned in the request. Defaults to 100 (max) unless overridden by _limit filter.
result_total Real Total number of results found.

Back To Top

ModEvent

mod.io Response Schema: Get Mod Events

This struct is referenced by the following structs:


Member Type Description
id Real Unique id of the event object.
mod_id Real Unique id of the parent mod.
user_id Real Unique id of the user who performed the action.
date_added Real Unix timestamp of date the event occurred.
event_type String Type of event that was triggered. List of possible events:

- MODFILE_CHANGED
- MOD_AVAILABLE
- MOD_UNAVAILABLE
- MOD_EDITED
- MOD_DELETED
- MOD_TEAM_CHANGED

Back To Top

Modfile

mod.io Response Schema: Modfile Object

This struct is referenced by the following functions:

This struct is referenced by the following structs:


Member Type Description
id Real Unique modfile id.
mod_id Real Unique mod id.
date_added Real Unix timestamp of date file was added.
date_scanned Real Unix timestamp of date file was virus scanned.
virus_status Real Current virus scan status of the file. For newly added files that have yet to be scanned this field will change frequently until a scan is complete:

0 = Not scanned
1 = Scan complete
2 = In progress
3 = Too large to scan
4 = File not found
5 = Error Scanning
virus_positive Real Was a virus detected:

0 = No threats detected
1 = Flagged as malicious
virustotal_hash String > DEPRECATED
>
> No longer used and will be removed in subsequent API version.
filesize Real Size of the file in bytes.
filesize_uncompressed Real The uncompressed filesize of the zip archive.
filehash Filehash Contains a dictionary of filehashes for the contents of the download.
filename String Filename including extension.
version String Release version this file represents.
changelog String Changelog for the file.
metadata_blob String Metadata stored by the game developer for this file.
download Download Contains download data for the modfile.
platforms ModfilePlatform Contains modfile platform data.

Back To Top

ModfilePlatform

mod.io Response Schema: Modfile Platform Object

This struct is referenced by the following structs:


Member Type Description
platform String A target platform.
status Real The status of the modfile for the corresponding platform. Possible values:

0 = Pending
1 = Approved
2 = Denied

Back To Top

ModMedia

mod.io Response Schema: Mod Media Object

This struct is referenced by the following structs:


Member Type Description
youtube Array of String Array of YouTube links.
sketchfab Array of String Array of SketchFab links.
images Array of Image Array of image objects (a gallery).

Back To Top

ModPlatforms

mod.io Response Schema: Mod Platforms Object

This struct is referenced by the following structs:


Member Type Description
platform String A target platform.
modfile_live Real The unique id of the modfile that is currently live on the platform specified in the platform field.

Back To Top

ModStats

mod.io Response Schema: Mod Stats Object

This struct is referenced by the following functions:

This struct is referenced by the following structs:


Member Type Description
mod_id Real Unique mod id.
popularity_rank_position Real Current rank of the mod.
popularity_rank_total_mods Real Number of ranking spots the current rank is measured against.
downloads_today Real Number of total mod downloads. Count resets around 11:00 UTC+11 daily.
downloads_total Real Number of total mod downloads.
subscribers_total Real Number of total users who have subscribed to the mod.
ratings_total Real Number of times this mod has been rated.
ratings_positive Real Number of positive ratings.
ratings_negative Real Number of negative ratings.
ratings_percentage_positive Real Number of positive ratings, divided by the total ratings to determine its percentage score.
ratings_weighted_aggregate Real Overall rating of this item calculated using the Wilson score confidence interval. This column is good to sort on, as it will order items based on number of ratings and will place items with many positive ratings above those with a higher score but fewer ratings.
ratings_display_text String Textual representation of the rating in format:

- Overwhelmingly Positive
- Very Positive
- Positive
- Mostly Positive
- Mixed
- Negative
- Mostly Negative
- Very Negative
- Overwhelmingly Negative
- Unrated
date_expires Real Unix timestamp until this mods's statistics are considered stale.

Back To Top

ModTag

mod.io Response Schema: Mod Tag Object

This struct is referenced by the following structs:


Member Type Description
name String Tag name.
date_added Real Unix timestamp of date tag was applied.

Back To Top

Rating

mod.io Response Schema: Rating Object

This struct is referenced by the following structs:


Member Type Description
game_id Real Unique game id.
mod_id Real Unique mod id.
rating Real Mod rating value:

- 1 = Positive Rating
- -1 = Negative Rating
date_added Real Unix timestamp of date rating was submitted.

Back To Top

TeamMember

mod.io Response Schema: Team Member Object

This struct is referenced by the following structs:


Member Type Description
id Real Unique team member id.
user User The user associated with this team access.
level Real Level of permission the user has:

1 = Moderator (can moderate comments and content attached)
4 = Manager (moderator access, including uploading builds and editing settings except supply and team members)
8 = Administrator (full access, including editing the supply and team)
date_added Real Unix timestamp of the date the user was added to the team.
position String Custom title given to the user in this team.
invite_pending Real If the team member invitation is still pending:

0 = Invitation Accepted
1 = Invitation Pending

Back To Top

Terms

mod.io Response Schema: Terms Object

This struct is referenced by the following functions:


Member Type Description
plaintext String The terms text in plaintext formatting.
html String The terms text in HTML formatting.
buttons Struct The buttons to embed into the Terms.

* agree: a struct containing the "agree" text
* disagree: a struct containing the "disagree" text
links Struct The links to embed into the Terms.

* website (Struct) Website link.
* terms (Struct) Terms of Use link.
* privacy (Struct) Privacy Policy link.
* manage (Struct) Manage User Account link.

Back To Top

Theme

mod.io Response Schema: Theme Object

This struct is referenced by the following structs:


Member Type Description
primary String The primary hex color code.
dark String The dark hex color code.
light String The light hex color code.
success String The success hex color code.
warning String The warning hex color code.
danger String The danger hex color code.

Back To Top

User

mod.io Response Schema: User Object

This struct is referenced by the following functions:

This struct is referenced by the following structs:


Member Type Description
id Real Unique id of the user.
name_id String Path for the user on mod.io. For example: https://mod.io/u/**name-id-here **
username String Username of the user.
display_name_portal String 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.
date_online Real Unix timestamp of date the user was last online.
date_joined Real Unix timestamp of date the user joined.
avatar Avatar Contains media URL's to the users avatar.
timezone String Deprecated: No longer used and will be removed in subsequent API version.
language String 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.
profile_url String URL to the user's profile.

Back To Top

UserEvent

mod.io Response Schema: User Event Object

This struct is referenced by the following structs:


Member Type Description
id Real Unique id of the event object.
game_id Real Unique id of the parent game.
mod_id Real Unique id of the parent mod.
user_id Real Unique id of the user who performed the action.
date_added Real Unix timestamp of date the event occurred.
event_type String Type of event that was triggered. List of possible events:

- USER_TEAM_JOIN
- USER_TEAM_LEAVE
- USER_SUBSCRIBE
- USER_UNSUBSCRIBE

Back To Top

WebMessage

mod.io Response Schema: Web Message Object

This struct is referenced by the following functions:


Member Type Description
code Real HTTP response code.
success Boolean Was the request completed successfully?
message String Optional message to display to the user.

GameMaker 2023

Clone this wiki locally