Skip to main content

Guide Object

Contains Guide data.

idinteger<int32>

Unique id of the guide.

Example: 1209
game_idinteger<int32>

Unique id of the parent game.

Example: 3
game_namestring

Name of the parent game.

Example: My Awesome Game
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
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 the date the guide was made.

Example: 1509922961
date_updatedinteger<int32>

Unix timestamp of the date the guide was updated.

Example: 1509922961
date_liveinteger<int32>

Unix timestamp of the date the guide was set live.

Example: 1509922961
statusGuide Permission Enum (integer)

Status of the guide, see status and visibility for details).

Enum ValueDescription
NOT_ACCEPTED (0)Not accepted.
ACCEPTED (1)Accepted and live.
DELETED (3)Deleted.

Possible values: [0, 1, 3]

Example: 1
urlstring

URL to the guide.

Example: https://mod.io/g/rogue-knight/r/getting-started
namestring

The name of the guide

Example: Getting Started
name_idstring

Path for the guide on mod.io. For example: https://mod.io/g/rogue-knight/r/__getting-started__

Example: getting-started
summarystring

The summary of the guide

Example: Alright, so let's get started with modding on mod.io
descriptionstring

Detailed description of the guide (the contents) which allows HTML.

Example: <h1>Getting Started</h2><p>Download this suspiciou....
community_optionsGuide Community Options Enum (integer)

The bitwise community options that are applied to this guide, allowing or disabling guide comments. Can be one of

Enum ValueDescription
DISABLED (0)Disabled
ALLOWS_COMMENTS (2048)Allows comments (default)

Possible values: [0, 2048]

Example: 2048
tags object[]

Contains guide tag data.

  • Array [
    • namestring

    Tag name.

    Example: Instructions
    date_addedinteger<int32>

    Unix timestamp of date tag was applied.

    Example: 1499841487
    countinteger<int32>

    The amount of times this tag has been applied to guides. This value will only be returned for the Get Guide Tags endpoint.

    Example: 22
  • ]
    • stats object[]

    Contains stats data.

  • Array [
    • guide_idinteger<int32>

    Unique guide id.

    Example: 2
    visits_todayinteger<int32>

    Last 24hours of visits for this guide

    Example: 0
    visits_totalinteger<int32>

    Total number of visits for this guide

    Example: 0
    comments_totalinteger<int32>

    Total number of comments for this guide

    Example: 0
  • ]
    • Guide Object
    {
      "id": 1209,
      "game_id": 3,
      "game_name": "My Awesome Game",
      "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"
      },
      "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": 1509922961,
      "date_updated": 1509922961,
      "date_live": 1509922961,
      "status": "1",
      "url": "https://mod.io/g/rogue-knight/r/getting-started",
      "name": "Getting Started",
      "name_id": "getting-started",
      "summary": "Alright, so let's get started with modding on mod.io",
      "description": "<h1>Getting Started</h2><p>Download this suspiciou....",
      "community_options": "2048",
      "tags": [
        {
          "name": "Instructions",
          "date_added": 1499841487,
          "count": 22
        }
      ],
      "stats": [
        {
          "guide_id": 2,
          "visits_today": 0,
          "visits_total": 0,
          "comments_total": 0
        }
      ]
    }