Skip to main content

Agreement Version Object

Contains Agreement data.

idinteger<int32>

Unique id of the agreement.

Example: 1
is_activeboolean

Is the agreement currently active? (This can also be determined if date_live <= the current time).

Example: true
is_latestboolean

Is this the latest version of the agreement?

Example: true
typeAgreement Type Enum (integer)
Enum ValueDescription
TOU (1)Terms
PRIVACY (2)Privacy
GAME (3)Game
API (4)API
MONETIZATION (5)Monetization
AUP (6)AUP
COOKIES (7)Cookies
REFUND (8)Refund

Possible values: [1, 2, 3, 4, 5, 6, 7, 8]

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 agreement was added.

Example: 1509922961
date_updatedinteger<int32>

Unix timestamp of the date the agreement was updated.

Example: 1509922961
date_liveinteger<int32>

Unix timestamp of the date the agreement was set live.

Example: 1509922961
namestring

Name of the agreement.

Example: Terms of Use
changelogstring

Changelog for version of this agreement.

Example:
descriptionstring

The contents of the agreement.

Example: Privacy Agreement - 20/11/2020.....
adjacent_versionsobject

The previous and next versions of the agreement.

Example: 'previous': { 'id': 13, 'date_live': 1592381157 }, 'next': { 'id': 31, 'date_live': 1722400117 }
Agreement Version Object
{
"id": 1,
"is_active": true,
"is_latest": true,
"type": 1,
"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,
"name": "Terms of Use",
"changelog": "",
"description": "Privacy Agreement - 20/11/2020.....",
"adjacent_versions": "'previous': { 'id': 13, 'date_live': 1592381157 }, 'next': { 'id': 31, 'date_live': 1722400117 }"
}