ModWorkshop API Documentation

Introduction

Base URL: https://api.modworkshop.net

The ModWorkshop API is available for everyone to use.

Do note that by using the API you must follow the following guidelines:

Do not spam the API.
Do not replicate the site or remove the need to visit the site to download mods. Exceptions: You are allowed to implement updates, you are allowed to make a mod downloadable to ease the process of joining a game with mods (Example: downloading maps). Integration to the site itself is fine too (We'll add ways to download mods directly to mod managers soon).
Respect user's privacy and do not store their information without their permission.

Officially, at the moment the API only supports GET requests. More support will come in the future, but will require the use of API keys.

Authenticating requests

This API is not authenticated.

Games

API routes for interacting with game sections.

Get Game

GET

https://api.modworkshop.net

/games/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the game.

Example:

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.modworkshop.net/games/2" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Edit Game

PUT

PATCH

https://api.modworkshop.net

/games/{id}

requires authentication

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the game.

Example:

Body Parameters

name

string

Must not be greater than 150 characters.

Example:

buttons

string

Must not be greater than 1000 characters.

Example:

jflutblwmxkin

thumbnail_file

string

Must not be greater than 512000 characters.

Example:

zfvfit

banner_file

string

Must not be greater than 512000 characters.

Example:

fzuifejjiowtepizuhal

short_name

string

Must not be greater than 30 characters.

Example:

iegkii

webhook_url

string

Must not be greater than 1000 characters.

Example:

http://crist.com/fugiat-ut-soluta-asperiores-odio-enim-sed-sit-eos

mod_manager_ids

integer[]

Must be at least 1.

Example:

[79]

default_mod_manager_id

string

Auth

Bearer

Headers

URL Parameters

Body

{ "name": "mz", "buttons": "jflutblwmxkin", "thumbnail_file": "zfvfit", "banner_file": "fzuifejjiowtepizuhal", "short_name": "iegkii", "webhook_url": "http:\/\/crist.com\/fugiat-ut-soluta-asperiores-odio-enim-sed-sit-eos", "mod_manager_ids": [ 79 ], "default_mod_manager_id": null }

Received response

Example request:

curl --request PUT \
    "https://api.modworkshop.net/games/2" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"mz\",
    \"buttons\": \"jflutblwmxkin\",
    \"thumbnail_file\": \"zfvfit\",
    \"banner_file\": \"fzuifejjiowtepizuhal\",
    \"short_name\": \"iegkii\",
    \"webhook_url\": \"http:\\/\\/crist.com\\/fugiat-ut-soluta-asperiores-odio-enim-sed-sit-eos\",
    \"mod_manager_ids\": [
        79
    ]
}"

GET games/{game_id}/admin-data

GET

https://api.modworkshop.net

/games/{game_id}/admin-data

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

game_id

integer

required

The ID of the game.

Example:

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.modworkshop.net/games/2/admin-data" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Delete Game

DELETE

https://api.modworkshop.net

/games/{id}

Deletes a game, if it has no mods.

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the game.

Example:

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.modworkshop.net/games/2" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Game Section Data

GET

https://api.modworkshop.net

/games/{game_id}/game-section-data

It's like /mods but returns the game too. It's used to avoid 2 requests in the game section so it's faster.

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

game_id

integer

required

The ID of the game.

Example:

Body Parameters

query

string

Must not be greater than 150 characters.

Example:

aqtpalzhobtopslrhopluewe

limit

integer

Must be at least 1. Must not be greater than 50.

Example:

game_id

integer

Must be at least 1.

Example:

category_id

integer

Must be at least 1.

Example:

tags

integer[]

Must be at least 1.

Example:

[14]

liked

boolean

Example:

categories

integer[]

Must be at least 1.

Example:

[18]

block_tags

integer[]

Must be at least 1.

Example:

[63]

user_id

integer

Must be at least 1.

Example:

collab

boolean

Example:

ignore_blocked_users

boolean

Example:

sort

string

Must be one of:

bumped_at
published_at
likes
downloads
views
score
weekly_score
daily_score
random
best_match
name

Example:

bumped_at

Headers

URL Parameters

Body

{ "query": "aqtpalzhobtopslrhopluewe", "limit": 3, "game_id": 90, "category_id": 8, "tags": [ 14 ], "liked": true, "categories": [ 18 ], "block_tags": [ 63 ], "user_id": 48, "collab": true, "ignore_blocked_users": true, "sort": "bumped_at" }

Received response

Example request:

curl --request GET \
    --get "https://api.modworkshop.net/games/2/game-section-data" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"query\": \"aqtpalzhobtopslrhopluewe\",
    \"limit\": 3,
    \"game_id\": 90,
    \"category_id\": 8,
    \"tags\": [
        14
    ],
    \"liked\": true,
    \"categories\": [
        18
    ],
    \"block_tags\": [
        63
    ],
    \"user_id\": 48,
    \"collab\": true,
    \"ignore_blocked_users\": true,
    \"sort\": \"bumped_at\"
}"

Example response:

Get Game User

GET

https://api.modworkshop.net

/games/{game_id}/users/{user}

Returns the user as they are supposed to be when inside of a game. Handles roles and colors.

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

game_id

integer

required

The ID of the game.

Example:

user

integer

required

The user.

Example:

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.modworkshop.net/games/2/users/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Get Game User Data

GET

https://api.modworkshop.net

/games/{game_id}/users/{user_id}/data

Returns game data for a user. Currently used for roles.

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

game_id

integer

required

The ID of the game.

Example:

user_id

integer

required

The ID of the user.

Example:

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.modworkshop.net/games/2/users/1/data" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Get Game Data

GET

https://api.modworkshop.net

/games/{game_id}/data

Returns basic game data like announcements. For moderators, it returns report and waiting mods count.

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

game_id

integer

required

The ID of the game.

Example:

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.modworkshop.net/games/2/data" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Set User Roles

PATCH

https://api.modworkshop.net

/games/{game_id}/users/{user_id}/roles

requires authentication

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

game_id

integer

required

The ID of the game.

Example:

user_id

integer

required

The ID of the user.

Example:

Body Parameters

role_ids

integer[]

Must be at least 1.

Example:

[76]

Auth

Bearer

Headers

URL Parameters

Body

{ "role_ids": [ 76 ] }

Received response

Example request:

curl --request PATCH \
    "https://api.modworkshop.net/games/2/users/1/roles" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"role_ids\": [
        76
    ]
}"

Roles

Get List of Games Roles

GET

https://api.modworkshop.net

/games/{game_id}/roles

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

game_id

integer

required

The ID of the game.

Example:

Body Parameters

query

string

Must not be greater than 150 characters.

Example:

uukfdjqdslabbwmbdtm

limit

integer

Must be at least 1. Must not be greater than 50.

Example:

Headers

URL Parameters

Body

{ "query": "uukfdjqdslabbwmbdtm", "limit": 25 }

Received response

Example request:

curl --request GET \
    --get "https://api.modworkshop.net/games/2/roles" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"query\": \"uukfdjqdslabbwmbdtm\",
    \"limit\": 25
}"

Example response:

Create Game Role

POST

https://api.modworkshop.net

/games/{game_id}/roles

requires authentication

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

game_id

integer

required

The ID of the game.

Example:

Body Parameters

name

string

Must be at least 2 characters. Must not be greater than 30 characters.

Example:

dotpfyttzumxxzym

tag

string

Must be at least 2 characters. Must not be greater than 30 characters.

Example:

tfzcagbfgucolp

desc

string

Must not be greater than 1000 characters.

Example:

crrdpjsxvzsyklqfwdkx

color

string

Must not be greater than 8 characters.

Example:

ggnwegh

is_vanity

boolean

self_assignable

boolean

Example:

order

integer

Must not be greater than 1001.

Example:

permissions

object

Auth

Bearer

Headers

URL Parameters

Body

{ "name": "dotpfyttzumxxzym", "tag": "tfzcagbfgucolp", "desc": "crrdpjsxvzsyklqfwdkx", "color": "ggnwegh", "is_vanity": false, "self_assignable": true, "order": 16, "permissions": null }

Received response

Example request:

curl --request POST \
    "https://api.modworkshop.net/games/2/roles" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"dotpfyttzumxxzym\",
    \"tag\": \"tfzcagbfgucolp\",
    \"desc\": \"crrdpjsxvzsyklqfwdkx\",
    \"color\": \"ggnwegh\",
    \"is_vanity\": false,
    \"self_assignable\": true,
    \"order\": 16
}"

Get Game Role

GET

https://api.modworkshop.net

/games/{game_id}/roles/{game_role_id}

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

game_id

integer

required

The ID of the game.

Example:

game_role_id

integer

required

The ID of the game role.

Example:

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.modworkshop.net/games/2/roles/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Edit Game Role

PUT

PATCH

https://api.modworkshop.net

/games/{game_id}/roles/{game_role_id}

requires authentication

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

game_id

integer

required

The ID of the game.

Example:

game_role_id

integer

required

The ID of the game role.

Example:

Body Parameters

name

string

Must be at least 2 characters. Must not be greater than 30 characters.

Example:

vvwpgqlqxresysnam

tag

string

Must be at least 2 characters. Must not be greater than 30 characters.

Example:

vwpumjnjkr

desc

string

Must not be greater than 1000 characters.

Example:

lhczxfjhqbdg

color

string

Must not be greater than 8 characters.

Example:

thqt

is_vanity

boolean

self_assignable

boolean

order

integer

Must not be greater than 1001.

Example:

permissions

object

Auth

Bearer

Headers

URL Parameters

Body

{ "name": "vvwpgqlqxresysnam", "tag": "vwpumjnjkr", "desc": "lhczxfjhqbdg", "color": "thqt", "is_vanity": false, "self_assignable": false, "order": 18, "permissions": null }

Received response

Example request:

curl --request PUT \
    "https://api.modworkshop.net/games/2/roles/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"vvwpgqlqxresysnam\",
    \"tag\": \"vwpumjnjkr\",
    \"desc\": \"lhczxfjhqbdg\",
    \"color\": \"thqt\",
    \"is_vanity\": false,
    \"self_assignable\": false,
    \"order\": 18
}"

Delete Game Role

DELETE

https://api.modworkshop.net

/games/{game_id}/roles/{game_role_id}

requires authentication

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

game_id

integer

required

The ID of the game.

Example:

game_role_id

integer

required

The ID of the game role.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.modworkshop.net/games/2/roles/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Mods

Files

List of Mod Files

GET

https://api.modworkshop.net

/mods/{mod_id}/files

Returns a list of files of a mod.

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

mod_id

integer

required

The ID of the mod.

Example:

Body Parameters

query

string

Must not be greater than 150 characters.

Example:

alkepnkynpvrz

limit

integer

Must be at least 1. Must not be greater than 50.

Example:

Headers

URL Parameters

Body

{ "query": "alkepnkynpvrz", "limit": 5 }

Received response

Example request:

curl --request GET \
    --get "https://api.modworkshop.net/mods/1/files" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"query\": \"alkepnkynpvrz\",
    \"limit\": 5
}"

Example response:

Upload Mod File

POST

https://api.modworkshop.net

/mods/{mod_id}/files

requires authentication

Upload a new file to a mod.

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

mod_id

integer

required

The ID of the mod.

Example:

Body Parameters

file

string

Auth

Bearer

Headers

URL Parameters

Body

{ "file": null }

Received response

Example request:

curl --request POST \
    "https://api.modworkshop.net/mods/1/files" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \

Get File

GET

https://api.modworkshop.net

/files/{id}

Returns a file. If the mod it belongs to is accessible.

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the file.

Example:

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.modworkshop.net/files/4" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Update File

PUT

PATCH

https://api.modworkshop.net

/files/{id}

requires authentication

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the file.

Example:

Body Parameters

name

string

Must be at least 2 characters. Must not be greater than 100 characters.

Example:

oaqmiacl

label

string

Must not be greater than 100 characters.

Example:

wyaq

desc

string

Must not be greater than 1000 characters.

Example:

vdmeeigqeo

version

string

Must not be greater than 255 characters.

Example:

rduuotlwdjhwdflycxfoqgwur

display_order

integer

Must be at least -1000. Must not be greater than 1000.

Example:

image_id

integer

Example:

change_file

string

Auth

Bearer

Headers

URL Parameters

Body

{ "name": "oaqmiacl", "label": "wyaq", "desc": "vdmeeigqeo", "version": "rduuotlwdjhwdflycxfoqgwur", "display_order": 2, "image_id": 14, "change_file": null }

Received response

Example request:

curl --request PUT \
    "https://api.modworkshop.net/files/4" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"oaqmiacl\",
    \"label\": \"wyaq\",
    \"desc\": \"vdmeeigqeo\",
    \"version\": \"rduuotlwdjhwdflycxfoqgwur\",
    \"display_order\": 2,
    \"image_id\": 14
}"

Delete File

DELETE

https://api.modworkshop.net

/files/{id}

requires authentication

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the file.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.modworkshop.net/files/4" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Download File

GET

https://api.modworkshop.net

/files/{file_id}/download

Begins a download of a file

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

file_id

integer

required

The ID of the file.

Example:

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.modworkshop.net/files/4/download" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Get File Version

GET

https://api.modworkshop.net

/files/{file_id}/version

Returns the version set for the file

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

file_id

integer

required

The ID of the file.

Example:

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.modworkshop.net/files/4/version" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Download First File

GET

https://api.modworkshop.net

/mods/{mod_id}/download

Downloads the first available file

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

mod_id

integer

required

The ID of the mod.

Example:

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.modworkshop.net/mods/1/download" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Delete All Mod FIles

DELETE

https://api.modworkshop.net

/mods/{mod_id}/files

requires authentication

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

mod_id

integer

required

The ID of the mod.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.modworkshop.net/mods/1/files" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Images

Get List of Mod Images

GET

https://api.modworkshop.net

/mods/{mod_id}/images

Returns images of the mod

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

mod_id

integer

required

The ID of the mod.

Example:

Body Parameters

limit

integer

Must be at least 1. Must not be greater than 50.

Example:

only_visible

boolean

Example:

Headers

URL Parameters

Body

{ "limit": 18, "only_visible": true }

Received response

Example request:

curl --request GET \
    --get "https://api.modworkshop.net/mods/1/images" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"limit\": 18,
    \"only_visible\": true
}"

Example response:

Upload Image

POST

https://api.modworkshop.net

/mods/{mod_id}/images

Upload a new image to the mod

Headers

Content-Type

Example:

multipart/form-data

Example:

application/json

URL Parameters

mod_id

integer

required

The ID of the mod.

Example:

Body Parameters

file

required

Must be a file.

Example:

/tmp/phpBoAgjI

Headers

URL Parameters

Body

Received response

Example request:

curl --request POST \
    "https://api.modworkshop.net/mods/1/images" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "file=@/tmp/phpBoAgjI"

Get Image

GET

https://api.modworkshop.net

/images/{id}

Returns data about a single image

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the image.

Example:

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.modworkshop.net/images/18" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Delete an Image

DELETE

https://api.modworkshop.net

/images/{id}

requires authentication

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the image.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.modworkshop.net/images/11" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Delete all Mod Images

DELETE

https://api.modworkshop.net

/mods/{mod_id}/images

requires authentication

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

mod_id

integer

required

The ID of the mod.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.modworkshop.net/mods/1/images" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Get List of Mod Links

GET

https://api.modworkshop.net

/mods/{mod_id}/links

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

mod_id

integer

required

The ID of the mod.

Example:

Body Parameters

query

string

Must not be greater than 150 characters.

Example:

duvplnuziefslqex

limit

integer

Must be at least 1. Must not be greater than 50.

Example:

Headers

URL Parameters

Body

{ "query": "duvplnuziefslqex", "limit": 12 }

Received response

Example request:

curl --request GET \
    --get "https://api.modworkshop.net/mods/1/links" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"query\": \"duvplnuziefslqex\",
    \"limit\": 12
}"

Example response:

Create Link

POST

https://api.modworkshop.net

/mods/{mod_id}/links

requires authentication

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

mod_id

integer

required

The ID of the mod.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.modworkshop.net/mods/1/links" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Get Link

GET

https://api.modworkshop.net

/links/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the link.

Example:

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.modworkshop.net/links/12" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Edit Link

PUT

PATCH

https://api.modworkshop.net

/links/{id}

requires authentication

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the link.

Example:

Body Parameters

name

string

required

Must be at least 3 characters. Must not be greater than 255 characters.

Example:

btsocjdpdngrjveweq

url

string

required

Must be a valid URL. Must be at least 3 characters. Must not be greater than 1000 characters.

Example:

http://www.witting.org/laboriosam-assumenda-voluptatem-voluptatem-rerum-sed-cupiditate-ratione

desc

string

Must not be greater than 1000 characters.

Example:

label

string

Must not be greater than 100 characters.

Example:

hwpfkjwzjypffbbdkrgieny

version

string

Must not be greater than 255 characters.

Example:

bxplimflwhwdr

image_id

integer

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "name": "btsocjdpdngrjveweq", "url": "http:\/\/www.witting.org\/laboriosam-assumenda-voluptatem-voluptatem-rerum-sed-cupiditate-ratione", "desc": "so", "label": "hwpfkjwzjypffbbdkrgieny", "version": "bxplimflwhwdr", "image_id": 3 }

Received response

Example request:

curl --request PUT \
    "https://api.modworkshop.net/links/11" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"btsocjdpdngrjveweq\",
    \"url\": \"http:\\/\\/www.witting.org\\/laboriosam-assumenda-voluptatem-voluptatem-rerum-sed-cupiditate-ratione\",
    \"desc\": \"so\",
    \"label\": \"hwpfkjwzjypffbbdkrgieny\",
    \"version\": \"bxplimflwhwdr\",
    \"image_id\": 3
}"

Delete Link

DELETE

https://api.modworkshop.net

/links/{id}

requires authentication

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the link.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.modworkshop.net/links/3" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Get List of Mods

GET

https://api.modworkshop.net

/games/{game_id}/mods

Returns many mods, has a few options for searching the right mods

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

game_id

integer

required

The ID of the game.

Example:

Body Parameters

query

string

Must not be greater than 150 characters.

Example:

idocdpotgdbebxl

limit

integer

Must be at least 1. Must not be greater than 50.

Example:

game_id

integer

Must be at least 1.

Example:

category_id

integer

Must be at least 1.

Example:

tags

integer[]

Must be at least 1.

Example:

[55]

liked

boolean

categories

integer[]

Must be at least 1.

Example:

[27]

block_tags

integer[]

Must be at least 1.

Example:

[82]

user_id

integer

Must be at least 1.

Example:

collab

boolean

ignore_blocked_users

boolean

Example:

sort

string

Must be one of:

bumped_at
published_at
likes
downloads
views
score
weekly_score
daily_score
random
best_match
name

Example:

score

Headers

URL Parameters

Body

{ "query": "idocdpotgdbebxl", "limit": 23, "game_id": 49, "category_id": 43, "tags": [ 55 ], "liked": false, "categories": [ 27 ], "block_tags": [ 82 ], "user_id": 77, "collab": false, "ignore_blocked_users": true, "sort": "score" }

Received response

Example request:

curl --request GET \
    --get "https://api.modworkshop.net/games/2/mods" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"query\": \"idocdpotgdbebxl\",
    \"limit\": 23,
    \"game_id\": 49,
    \"category_id\": 43,
    \"tags\": [
        55
    ],
    \"liked\": false,
    \"categories\": [
        27
    ],
    \"block_tags\": [
        82
    ],
    \"user_id\": 77,
    \"collab\": false,
    \"ignore_blocked_users\": true,
    \"sort\": \"score\"
}"

Example response:

Create Mod

POST

https://api.modworkshop.net

/games/{game_id}/mods

requires authentication

Creates a new mod

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

game_id

integer

required

The ID of the game.

Example:

Body Parameters

name

string

Must be at least 3 characters. Must not be greater than 100 characters.

Example:

jtritucjgfmzqdrjikzzl

desc

string

Must be at least 3 characters. Must not be greater than 30000 characters.

Example:

pusxescbirmpdwogegrcc

license

string

Must not be greater than 30000 characters.

Example:

flyerjaf

changelog

string

Must not be greater than 30000 characters.

Example:

kenywrlu

instructions

string

Must not be greater than 30000 characters.

Example:

lufrro

short_desc

string

Must not be greater than 150 characters.

Example:

mfcjpq

donation

string

Must not be greater than 100 characters.

Example:

sxwjwmwtvxyzldsnmsyky

version

string

Must not be greater than 100 characters.

Example:

fhktv

visibility

string

Must be one of:

public
private
unlisted

Example:

private

category_id

integer

Must be at least 1.

Example:

thumbnail_id

integer

Must be at least 1.

Example:

background_id

integer

Must be at least 1.

Example:

background_opacity

number

Must be at least 0. Must not be greater than 1.

Example:

game_id

integer

Must be at least 1.

Example:

banner_id

integer

Must be at least 1.

Example:

instructs_template_id

integer

Must be at least 1.

Example:

tag_ids

integer[]

Must be at least 1.

Example:

[45]

download_id

integer

Must be at least 1.

Example:

allowed_storage

integer

Must be at least 1. Must not be greater than 1000.

Example:

download_type

string

Must be one of:

file
link

Example:

file

comments_disabled

boolean

Example:

send_for_approval

boolean

Example:

publish

boolean

disable_mod_managers

boolean

Auth

Bearer

Headers

URL Parameters

Body

{ "name": "jtritucjgfmzqdrjikzzl", "desc": "pusxescbirmpdwogegrcc", "license": "flyerjaf", "changelog": "kenywrlu", "instructions": "lufrro", "short_desc": "mfcjpq", "donation": "sxwjwmwtvxyzldsnmsyky", "version": "fhktv", "visibility": "private", "category_id": 57, "thumbnail_id": 42, "background_id": 53, "background_opacity": 1, "game_id": 39, "banner_id": 39, "instructs_template_id": 58, "tag_ids": [ 45 ], "download_id": 18, "allowed_storage": 15, "download_type": "file", "comments_disabled": true, "send_for_approval": true, "publish": false, "disable_mod_managers": false }

Received response

Example request:

curl --request POST \
    "https://api.modworkshop.net/games/2/mods" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"jtritucjgfmzqdrjikzzl\",
    \"desc\": \"pusxescbirmpdwogegrcc\",
    \"license\": \"flyerjaf\",
    \"changelog\": \"kenywrlu\",
    \"instructions\": \"lufrro\",
    \"short_desc\": \"mfcjpq\",
    \"donation\": \"sxwjwmwtvxyzldsnmsyky\",
    \"version\": \"fhktv\",
    \"visibility\": \"private\",
    \"category_id\": 57,
    \"thumbnail_id\": 42,
    \"background_id\": 53,
    \"background_opacity\": 1,
    \"game_id\": 39,
    \"banner_id\": 39,
    \"instructs_template_id\": 58,
    \"tag_ids\": [
        45
    ],
    \"download_id\": 18,
    \"allowed_storage\": 15,
    \"download_type\": \"file\",
    \"comments_disabled\": true,
    \"send_for_approval\": true,
    \"publish\": false,
    \"disable_mod_managers\": false
}"

Get Mod

GET

https://api.modworkshop.net

/mods/{id}

Returns a single mod

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the mod.

Example:

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.modworkshop.net/mods/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Edit Mod

PUT

PATCH

https://api.modworkshop.net

/mods/{id}

requires authentication

Updates data of a mod

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the mod.

Example:

Body Parameters

name

string

Must be at least 3 characters. Must not be greater than 100 characters.

Example:

zwdjyxkmobijmvgqdjzvfpm

desc

string

Must be at least 3 characters. Must not be greater than 30000 characters.

Example:

jjjleykxrwf

license

string

Must not be greater than 30000 characters.

Example:

qdkwoypdm

changelog

string

Must not be greater than 30000 characters.

Example:

kjixvqiwudrvsggjfjzfkjfl

instructions

string

Must not be greater than 30000 characters.

Example:

hywxxxgnojszznz

short_desc

string

Must not be greater than 150 characters.

Example:

donation

string

Must not be greater than 100 characters.

Example:

jwbxnrsvqyiqgiiv

version

string

Must not be greater than 100 characters.

Example:

veedscrrlsvgtirjqmcmppnh

visibility

string

Must be one of:

public
private
unlisted

Example:

private

category_id

integer

Must be at least 1.

Example:

thumbnail_id

integer

Must be at least 1.

Example:

background_id

integer

Must be at least 1.

Example:

background_opacity

number

Must be at least 0. Must not be greater than 1.

Example:

game_id

integer

Must be at least 1.

Example:

banner_id

integer

Must be at least 1.

Example:

instructs_template_id

integer

Must be at least 1.

Example:

tag_ids

integer[]

Must be at least 1.

Example:

[84]

download_id

integer

Must be at least 1.

Example:

allowed_storage

integer

Must be at least 1. Must not be greater than 1000.

Example:

download_type

string

Must be one of:

file
link

Example:

link

comments_disabled

boolean

Example:

send_for_approval

boolean

Example:

publish

boolean

Example:

disable_mod_managers

boolean

Auth

Bearer

Headers

URL Parameters

Body

{ "name": "zwdjyxkmobijmvgqdjzvfpm", "desc": "jjjleykxrwf", "license": "qdkwoypdm", "changelog": "kjixvqiwudrvsggjfjzfkjfl", "instructions": "hywxxxgnojszznz", "short_desc": "i", "donation": "jwbxnrsvqyiqgiiv", "version": "veedscrrlsvgtirjqmcmppnh", "visibility": "private", "category_id": 43, "thumbnail_id": 52, "background_id": 40, "background_opacity": 1, "game_id": 15, "banner_id": 82, "instructs_template_id": 4, "tag_ids": [ 84 ], "download_id": 25, "allowed_storage": 25, "download_type": "link", "comments_disabled": true, "send_for_approval": true, "publish": true, "disable_mod_managers": false }

Received response

Example request:

curl --request PUT \
    "https://api.modworkshop.net/mods/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"zwdjyxkmobijmvgqdjzvfpm\",
    \"desc\": \"jjjleykxrwf\",
    \"license\": \"qdkwoypdm\",
    \"changelog\": \"kjixvqiwudrvsggjfjzfkjfl\",
    \"instructions\": \"hywxxxgnojszznz\",
    \"short_desc\": \"i\",
    \"donation\": \"jwbxnrsvqyiqgiiv\",
    \"version\": \"veedscrrlsvgtirjqmcmppnh\",
    \"visibility\": \"private\",
    \"category_id\": 43,
    \"thumbnail_id\": 52,
    \"background_id\": 40,
    \"background_opacity\": 1,
    \"game_id\": 15,
    \"banner_id\": 82,
    \"instructs_template_id\": 4,
    \"tag_ids\": [
        84
    ],
    \"download_id\": 25,
    \"allowed_storage\": 25,
    \"download_type\": \"link\",
    \"comments_disabled\": true,
    \"send_for_approval\": true,
    \"publish\": true,
    \"disable_mod_managers\": false
}"

Delete Mod

DELETE

https://api.modworkshop.net

/mods/{id}

requires authentication

Deletes a mod and all of its contents.

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the mod.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.modworkshop.net/mods/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Transfer Ownership of a Mod

PATCH

https://api.modworkshop.net

/mods/{mod_id}/owner

requires authentication

Creates a transfer request, only once a user accepts can the mod be fully transfered.

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

mod_id

integer

required

The ID of the mod.

Example:

Body Parameters

owner_id

integer

required

Must be at least 1.

Example:

keep_owner_level

string

Which level to keep the owner as. If null, won't keep the owner as a member.

Must be one of:

collaborator
maintainer
viewer
contributor

Example:

viewer

Auth

Bearer

Headers

URL Parameters

Body

{ "owner_id": 65, "keep_owner_level": "viewer" }

Received response

Example request:

curl --request PATCH \
    "https://api.modworkshop.net/mods/1/owner" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"owner_id\": 65,
    \"keep_owner_level\": \"viewer\"
}"

Cancel Transfer Ownership Request

PATCH

https://api.modworkshop.net

/mods/{mod_id}/owner/cancel

requires authentication

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

mod_id

integer

required

The ID of the mod.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request PATCH \
    "https://api.modworkshop.net/mods/1/owner/cancel" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Accept Transfer Ownership Request

PATCH

https://api.modworkshop.net

/mods/{mod_id}/owner/accept

requires authentication

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

mod_id

integer

required

The ID of the mod.

Example:

Body Parameters

boolean

required

Auth

Bearer

Headers

URL Parameters

Body

{ "accept": false }

Received response

Example request:

curl --request PATCH \
    "https://api.modworkshop.net/mods/1/owner/accept" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"accept\": false
}"

POST Register a View

POST

https://api.modworkshop.net

/mods/{mod_id}/register-view

Registers a view for a mod, doesn't let you 'view' it twice Works with guests

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

mod_id

integer

required

The ID of the mod.

Example:

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.modworkshop.net/mods/1/register-view" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Register Download

POST

https://api.modworkshop.net

/mods/{mod_id}/register-download

Registers a download for a mod, doesn't let you 'download' it twice Works with guests

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

mod_id

integer

required

The ID of the mod.

Example:

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.modworkshop.net/mods/1/register-download" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

List of Waiting for Approval Mods

GET

https://api.modworkshop.net

/mods/waiting

requires authentication

Returns mods waiting for approval (approval == null)

Headers

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

query

string

Must not be greater than 150 characters.

Example:

fkropzybalgctg

limit

integer

Must be at least 1. Must not be greater than 50.

Example:

game_id

integer

Must be at least 1.

Example:

category_id

integer

Must be at least 1.

Example:

tags

integer[]

Must be at least 1.

Example:

[24]

liked

boolean

categories

integer[]

Must be at least 1.

Example:

[87]

block_tags

integer[]

Must be at least 1.

Example:

[60]

user_id

integer

Must be at least 1.

Example:

collab

boolean

Example:

ignore_blocked_users

boolean

Example:

sort

string

Must be one of:

bumped_at
published_at
likes
downloads
views
score
weekly_score
daily_score
random
best_match
name

Example:

views

Auth

Bearer

Headers

Body

{ "query": "fkropzybalgctg", "limit": 21, "game_id": 58, "category_id": 3, "tags": [ 24 ], "liked": false, "categories": [ 87 ], "block_tags": [ 60 ], "user_id": 38, "collab": true, "ignore_blocked_users": true, "sort": "views" }

Received response

Example request:

curl --request GET \
    --get "https://api.modworkshop.net/mods/waiting" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"query\": \"fkropzybalgctg\",
    \"limit\": 21,
    \"game_id\": 58,
    \"category_id\": 3,
    \"tags\": [
        24
    ],
    \"liked\": false,
    \"categories\": [
        87
    ],
    \"block_tags\": [
        60
    ],
    \"user_id\": 38,
    \"collab\": true,
    \"ignore_blocked_users\": true,
    \"sort\": \"views\"
}"

Example response:

List of Waiting for Approval Mods

GET

https://api.modworkshop.net

/games/{game_id}/mods/waiting

requires authentication

Returns mods waiting for approval (approval == null)

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

game_id

integer

required

The ID of the game.

Example:

Body Parameters

query

string

Must not be greater than 150 characters.

Example:

dzadzcu

limit

integer

Must be at least 1. Must not be greater than 50.

Example:

game_id

integer

Must be at least 1.

Example:

category_id

integer

Must be at least 1.

Example:

tags

integer[]

Must be at least 1.

Example:

[5]

liked

boolean

categories

integer[]

Must be at least 1.

Example:

[21]

block_tags

integer[]

Must be at least 1.

Example:

[41]

user_id

integer

Must be at least 1.

Example:

collab

boolean

ignore_blocked_users

boolean

Example:

sort

string

Must be one of:

bumped_at
published_at
likes
downloads
views
score
weekly_score
daily_score
random
best_match
name

Example:

bumped_at

Auth

Bearer

Headers

URL Parameters

Body

{ "query": "dzadzcu", "limit": 16, "game_id": 21, "category_id": 39, "tags": [ 5 ], "liked": false, "categories": [ 21 ], "block_tags": [ 41 ], "user_id": 39, "collab": false, "ignore_blocked_users": true, "sort": "bumped_at" }

Received response

Example request:

curl --request GET \
    --get "https://api.modworkshop.net/games/2/mods/waiting" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"query\": \"dzadzcu\",
    \"limit\": 16,
    \"game_id\": 21,
    \"category_id\": 39,
    \"tags\": [
        5
    ],
    \"liked\": false,
    \"categories\": [
        21
    ],
    \"block_tags\": [
        41
    ],
    \"user_id\": 39,
    \"collab\": false,
    \"ignore_blocked_users\": true,
    \"sort\": \"bumped_at\"
}"

Example response:

Get List of Popular Mods

GET

https://api.modworkshop.net

/games/{game_id}/popular-and-latest

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

game_id

integer

required

The ID of the game.

Example:

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.modworkshop.net/games/2/popular-and-latest" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Get Mod Version

GET

https://api.modworkshop.net

/mods/{mod_id}/version

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

mod_id

integer

required

The ID of the mod.

Example:

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.modworkshop.net/mods/1/version" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Get Mod Versions

GET

https://api.modworkshop.net

/mods/versions

Returns a list of versions (Up to 100 mods) Convenient way of getting many versions at once and avoid sending too many requests

Headers

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

mod_ids

integer[]

Must be at least 1. Must not be greater than 100.

Example:

[22]

Headers

Body

{ "mod_ids": [ 22 ] }

Received response

Example request:

curl --request GET \
    --get "https://api.modworkshop.net/mods/versions" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"mod_ids\": [
        22
    ]
}"

Example response:

Suspend Mod

PATCH

https://api.modworkshop.net

/mods/{mod_id}/suspended

requires authentication

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

mod_id

integer

required

The ID of the mod.

Example:

Body Parameters

status

boolean

required

notify

boolean

reason

string

Must be at least 3 characters. Must not be greater than 1000 characters.

Example:

ceturxnfyhrjbmnnzv

Auth

Bearer

Headers

URL Parameters

Body

{ "status": false, "notify": false, "reason": "ceturxnfyhrjbmnnzv" }

Received response

Example request:

curl --request PATCH \
    "https://api.modworkshop.net/mods/1/suspended" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"status\": false,
    \"notify\": false,
    \"reason\": \"ceturxnfyhrjbmnnzv\"
}"

Approve Mod

PATCH

https://api.modworkshop.net

/mods/{mod_id}/approved

requires authentication

Approves a waiting for approval mod.

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

mod_id

integer

required

The ID of the mod.

Example:

Body Parameters

status

boolean

required

Example:

notify

boolean

Example:

reason

string

Must not be greater than 1000 characters.

Example:

ymcjyra

Auth

Bearer

Headers

URL Parameters

Body

{ "status": true, "notify": true, "reason": "ymcjyra" }

Received response

Example request:

curl --request PATCH \
    "https://api.modworkshop.net/mods/1/approved" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"status\": true,
    \"notify\": true,
    \"reason\": \"ymcjyra\"
}"

Report Mod

POST

https://api.modworkshop.net

/mods/{mod_id}/reports

requires authentication

Reports the mod for moderators to look at it.

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

mod_id

integer

required

The ID of the mod.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.modworkshop.net/mods/1/reports" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Toggle Like

POST

https://api.modworkshop.net

/mods/{mod_id}/toggle-liked

requires authentication

Toggles the state of the like of the mod

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

mod_id

integer

required

The ID of the mod.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.modworkshop.net/mods/1/toggle-liked" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Get List of Liked Mods

GET

https://api.modworkshop.net

/mods/liked

requires authentication

Returns mods the user liked

Headers

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

query

string

Must not be greater than 150 characters.

Example:

ltyyaue

limit

integer

Must be at least 1. Must not be greater than 50.

Example:

game_id

integer

Must be at least 1.

Example:

category_id

integer

Must be at least 1.

Example:

tags

integer[]

Must be at least 1.

Example:

[64]

liked

boolean

categories

integer[]

Must be at least 1.

Example:

[84]

block_tags

integer[]

Must be at least 1.

Example:

[76]

user_id

integer

Must be at least 1.

Example:

collab

boolean

ignore_blocked_users

boolean

sort

string

Must be one of:

bumped_at
published_at
likes
downloads
views
score
weekly_score
daily_score
random
best_match
name

Example:

name

Auth

Bearer

Headers

Body

{ "query": "ltyyaue", "limit": 15, "game_id": 5, "category_id": 24, "tags": [ 64 ], "liked": false, "categories": [ 84 ], "block_tags": [ 76 ], "user_id": 1, "collab": false, "ignore_blocked_users": false, "sort": "name" }

Received response

Example request:

curl --request GET \
    --get "https://api.modworkshop.net/mods/liked" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"query\": \"ltyyaue\",
    \"limit\": 15,
    \"game_id\": 5,
    \"category_id\": 24,
    \"tags\": [
        64
    ],
    \"liked\": false,
    \"categories\": [
        84
    ],
    \"block_tags\": [
        76
    ],
    \"user_id\": 1,
    \"collab\": false,
    \"ignore_blocked_users\": false,
    \"sort\": \"name\"
}"

Example response:

Members

Accept Member Request

PATCH

https://api.modworkshop.net

/mods/{mod_id}/members/accept

requires authentication

Accepts incoming member request and make it active or delete it if rejected.

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

mod_id

integer

required

The ID of the mod.

Example:

Body Parameters

boolean

required

Auth

Bearer

Headers

URL Parameters

Body

{ "accept": false }

Received response

Example request:

curl --request PATCH \
    "https://api.modworkshop.net/mods/1/members/accept" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"accept\": false
}"

Create Mod Member

POST

https://api.modworkshop.net

/mods/{mod_id}/members

requires authentication

Add someone to be a mod member, it sends them a notification so they can accept the request

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

mod_id

integer

required

The ID of the mod.

Example:

Body Parameters

user_id

integer

required

Must be at least 1.

Example:

level

string

required

Must be one of:

maintainer
collaborator
viewer
contributor

Example:

collaborator

Auth

Bearer

Headers

URL Parameters

Body

{ "user_id": 42, "level": "collaborator" }

Received response

Example request:

curl --request POST \
    "https://api.modworkshop.net/mods/1/members" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"user_id\": 42,
    \"level\": \"collaborator\"
}"

Edit Member

PUT

PATCH

https://api.modworkshop.net

/mods/{mod_id}/members/{id}

@authenticated

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

mod_id

integer

required

The ID of the mod.

Example:

integer

required

The ID of the member.

Example:

Body Parameters

level

string

required

Must be one of:

collaborator
maintainer
viewer
contributor

Example:

collaborator

Headers

URL Parameters

Body

{ "level": "collaborator" }

Received response

Example request:

curl --request PUT \
    "https://api.modworkshop.net/mods/1/members/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"level\": \"collaborator\"
}"

Remove Member

DELETE

https://api.modworkshop.net

/mods/{mod_id}/members/{id}

requires authentication

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

mod_id

integer

required

The ID of the mod.

Example:

integer

required

The ID of the member.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.modworkshop.net/mods/1/members/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Dependencies

Create Dependency

POST

https://api.modworkshop.net

/mods/{mod_id}/dependencies

requires authentication

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

mod_id

integer

required

The ID of the mod.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.modworkshop.net/mods/1/dependencies" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Edit Dependency

PUT

PATCH

https://api.modworkshop.net

/mods/{mod_id}/dependencies/{id}

requires authentication

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

mod_id

integer

required

The ID of the mod.

Example:

integer

required

The ID of the dependency.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request PUT \
    "https://api.modworkshop.net/mods/1/dependencies/8" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Delete Dependency

DELETE

https://api.modworkshop.net

/mods/{mod_id}/dependencies/{id}

requires authentication

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

mod_id

integer

required

The ID of the mod.

Example:

integer

required

The ID of the dependency.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.modworkshop.net/mods/1/dependencies/13" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Comments

Get List of Comments

GET

https://api.modworkshop.net

/mods/{mod_id}/comments

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

mod_id

integer

required

The ID of the mod.

Example:

Body Parameters

query

string

Must not be greater than 150 characters.

Example:

vtdqucna

limit

integer

Must be at least 1. Must not be greater than 50.

Example:

Headers

URL Parameters

Body

{ "query": "vtdqucna", "limit": 23 }

Received response

Example request:

curl --request GET \
    --get "https://api.modworkshop.net/mods/1/comments" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"query\": \"vtdqucna\",
    \"limit\": 23
}"

Example response:

Create Comment

POST

https://api.modworkshop.net

/mods/{mod_id}/comments

requires authentication

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

mod_id

integer

required

The ID of the mod.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.modworkshop.net/mods/1/comments" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Subscribe to Comment

POST

https://api.modworkshop.net

/mods/{mod_id}/comments/subscription

requires authentication

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

mod_id

integer

required

The ID of the mod.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.modworkshop.net/mods/1/comments/subscription" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Unsubscribe from Comment

DELETE

https://api.modworkshop.net

/mods/{mod_id}/comments/subscription

requires authentication

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

mod_id

integer

required

The ID of the mod.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.modworkshop.net/mods/1/comments/subscription" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Get List of Categories

GET

https://api.modworkshop.net

/games/{game_id}/categories

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

game_id

integer

required

The ID of the game.

Example:

Body Parameters

query

string

Must not be greater than 150 characters.

Example:

vulslpnm

limit

integer

Must be at least 1. Must not be greater than 50.

Example:

Headers

URL Parameters

Body

{ "query": "vulslpnm", "limit": 8 }

Received response

Example request:

curl --request GET \
    --get "https://api.modworkshop.net/games/2/categories" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"query\": \"vulslpnm\",
    \"limit\": 8
}"

Example response:

Create Category

POST

https://api.modworkshop.net

/games/{game_id}/categories

requires authentication

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

game_id

integer

required

The ID of the game.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.modworkshop.net/games/2/categories" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Get Category

GET

https://api.modworkshop.net

/categories/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the category.

Example:

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.modworkshop.net/categories/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Edit Category

PUT

PATCH

https://api.modworkshop.net

/categories/{id}

requires authentication

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the category.

Example:

Body Parameters

name

string

Must not be greater than 150 characters.

Example:

bpslysinoqlccxmaezh

desc

string

Must not be greater than 1000 characters.

Example:

game_id

integer

Must be at least 1.

Example:

parent_id

integer

Must be at least 1.

Example:

display_order

integer

Must be at least -1000. Must not be greater than 1000.

Example:

thumbnail_file

string

Must not be greater than 512000 characters.

Example:

axbsgcrbrfvqn

approval_only

boolean

webhook_url

string

Must not be greater than 1000 characters.

Example:

http://kunze.com/debitis-itaque-dicta-eaque-amet.html

disable_mod_managers

boolean

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "name": "bpslysinoqlccxmaezh", "desc": "jl", "game_id": 80, "parent_id": 35, "display_order": 23, "thumbnail_file": "axbsgcrbrfvqn", "approval_only": false, "webhook_url": "http:\/\/kunze.com\/debitis-itaque-dicta-eaque-amet.html", "disable_mod_managers": true }

Received response

Example request:

curl --request PUT \
    "https://api.modworkshop.net/categories/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"bpslysinoqlccxmaezh\",
    \"desc\": \"jl\",
    \"game_id\": 80,
    \"parent_id\": 35,
    \"display_order\": 23,
    \"thumbnail_file\": \"axbsgcrbrfvqn\",
    \"approval_only\": false,
    \"webhook_url\": \"http:\\/\\/kunze.com\\/debitis-itaque-dicta-eaque-amet.html\",
    \"disable_mod_managers\": true
}"

Deletes Category. Only if it's empty

DELETE

https://api.modworkshop.net

/categories/{id}

requires authentication

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the category.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.modworkshop.net/categories/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Mass updates mods of a category, only used to move mods.

PATCH

https://api.modworkshop.net

/categories/{category_id}/mods

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

category_id

integer

required

The ID of the category.

Example:

Body Parameters

category_id

integer

Must be at least 1.

Example:

are_you_sure

boolean

required

Headers

URL Parameters

Body

{ "category_id": 34, "are_you_sure": false }

Received response

Example request:

curl --request PATCH \
    "https://api.modworkshop.net/categories/1/mods" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"category_id\": 34,
    \"are_you_sure\": false
}"

Users

API routes for interacting with users

Get List of Users

GET

https://api.modworkshop.net

/games/{game_id}/users

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

game_id

integer

required

The ID of the game.

Example:

Body Parameters

query

string

Must not be greater than 150 characters.

Example:

vizeayjngcsmgfztf

limit

integer

Must be at least 1. Must not be greater than 50.

Example:

Headers

URL Parameters

Body

{ "query": "vizeayjngcsmgfztf", "limit": 3 }

Received response

Example request:

curl --request GET \
    --get "https://api.modworkshop.net/games/2/users" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"query\": \"vizeayjngcsmgfztf\",
    \"limit\": 3
}"

Example response:

Edit User

PUT

PATCH

https://api.modworkshop.net

/users/{id}

requires authentication

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the user.

Example:

Body Parameters

name

string

Must be at least 3 characters. Must not be greater than 30 characters.

Example:

ekcqgvlmzwnhwrhypvwdjbcj

unique_name

string

Must contain only letters, numbers, dashes and underscores. Must be at least 3 characters. Must not be greater than 50 characters.

Example:

djgebjb

avatar_file

string

custom_color

string

Must not be greater than 7 characters.

Example:

bio

string

Must not be greater than 3000 characters.

Example:

alurzj

string

Must be a valid email address. Must not be greater than 255 characters.

Example:

corwin.madisyn@example.org

custom_title

string

Must not be greater than 100 characters.

Example:

uhkcswnexvxuebx

private_profile

boolean

invisible

boolean

banner_file

string

background_file

string

donation_url

string

Must not be greater than 255 characters.

Example:

http://predovic.org/soluta-neque-et-quas-culpa-nobis-veniam-ea

show_tag

string

Must be one of:

role
supporter_or_role
none

Example:

supporter_or_role

current_password

string

password

string

Must not be greater than 128 characters.

Example:

3l^NkBmjCb&BV

extra

object

default_mods_sort

string

default_mods_view

string

home_show_last_games

boolean

Example:

home_show_mods

boolean

home_show_threads

boolean

game_show_mods

boolean

game_show_threads

boolean

auto_subscribe_to_mod

boolean

auto_subscribe_to_thread

boolean

Example:

background_opacity

number

Must be at least 0. Must not be greater than 1.

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "name": "ekcqgvlmzwnhwrhypvwdjbcj", "unique_name": "djgebjb", "avatar_file": null, "custom_color": "bl", "bio": "alurzj", "email": "corwin.madisyn@example.org", "custom_title": "uhkcswnexvxuebx", "private_profile": false, "invisible": false, "banner_file": null, "background_file": null, "donation_url": "http:\/\/predovic.org\/soluta-neque-et-quas-culpa-nobis-veniam-ea", "show_tag": "supporter_or_role", "current_password": null, "password": "3l^NkBmjCb&BV", "extra": { "default_mods_sort": null, "default_mods_view": null, "home_show_last_games": true, "home_show_mods": false, "home_show_threads": false, "game_show_mods": false, "game_show_threads": false, "auto_subscribe_to_mod": false, "auto_subscribe_to_thread": true, "background_opacity": 1 } }

Received response

Example request:

curl --request PUT \
    "https://api.modworkshop.net/users/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"ekcqgvlmzwnhwrhypvwdjbcj\",
    \"unique_name\": \"djgebjb\",
    \"custom_color\": \"bl\",
    \"bio\": \"alurzj\",
    \"email\": \"corwin.madisyn@example.org\",
    \"custom_title\": \"uhkcswnexvxuebx\",
    \"private_profile\": false,
    \"invisible\": false,
    \"donation_url\": \"http:\\/\\/predovic.org\\/soluta-neque-et-quas-culpa-nobis-veniam-ea\",
    \"show_tag\": \"supporter_or_role\",
    \"password\": \"3l^NkBmjCb&BV\",
    \"extra\": {
        \"home_show_last_games\": true,
        \"home_show_mods\": false,
        \"home_show_threads\": false,
        \"game_show_mods\": false,
        \"game_show_threads\": false,
        \"auto_subscribe_to_mod\": false,
        \"auto_subscribe_to_thread\": true,
        \"background_opacity\": 1
    }
}"

Delete User

DELETE

https://api.modworkshop.net

/users/{id}

requires authentication

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the user.

Example:

Body Parameters

unique_name

string

required

Must contain only letters, numbers, dashes and underscores. Must be at least 3 characters. Must not be greater than 50 characters.

Example:

grnlmbukpexajolzmkyqcadl

are_you_sure

boolean

required

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "unique_name": "grnlmbukpexajolzmkyqcadl", "are_you_sure": true }

Received response

Example request:

curl --request DELETE \
    "https://api.modworkshop.net/users/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"unique_name\": \"grnlmbukpexajolzmkyqcadl\",
    \"are_you_sure\": true
}"

Get User

GET

https://api.modworkshop.net

/users/{user}

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user

integer

required

The ID of the user

Example:

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.modworkshop.net/users/18" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

GET users/{user_id}/comments

GET

https://api.modworkshop.net

/users/{user_id}/comments

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_id

integer

required

The ID of the user.

Example:

Body Parameters

query

string

Must not be greater than 150 characters.

Example:

iinxacdiidiumknfsnjhl

limit

integer

Must be at least 1. Must not be greater than 50.

Example:

Headers

URL Parameters

Body

{ "query": "iinxacdiidiumknfsnjhl", "limit": 5 }

Received response

Example request:

curl --request GET \
    --get "https://api.modworkshop.net/users/1/comments" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"query\": \"iinxacdiidiumknfsnjhl\",
    \"limit\": 5
}"

Example response:

GET users/{user_id}/threads

GET

https://api.modworkshop.net

/users/{user_id}/threads

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_id

integer

required

The ID of the user.

Example:

Body Parameters

query

string

Must not be greater than 150 characters.

Example:

ocvcditotdprglyyes

limit

integer

Must be at least 1. Must not be greater than 50.

Example:

category_name

string

Must not be greater than 100 characters.

Example:

qigruecpbr

category_id

integer

Must be at least 1.

Example:

tags

integer[]

Must be at least 1.

Example:

[55]

no_pins

boolean

forum_id

integer

Must be at least 1.

Example:

Headers

URL Parameters

Body

{ "query": "ocvcditotdprglyyes", "limit": 24, "category_name": "qigruecpbr", "category_id": 41, "tags": [ 55 ], "no_pins": false, "forum_id": 70 }

Received response

Example request:

curl --request GET \
    --get "https://api.modworkshop.net/users/1/threads" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"query\": \"ocvcditotdprglyyes\",
    \"limit\": 24,
    \"category_name\": \"qigruecpbr\",
    \"category_id\": 41,
    \"tags\": [
        55
    ],
    \"no_pins\": false,
    \"forum_id\": 70
}"

Example response:

Set User Roles

PATCH

https://api.modworkshop.net

/users/{user_id}/roles

requires authentication

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_id

integer

required

The ID of the user.

Example:

Body Parameters

role_ids

integer[]

Must be at least 2.

Example:

[86]

Auth

Bearer

Headers

URL Parameters

Body

{ "role_ids": [ 86 ] }

Received response

Example request:

curl --request PATCH \
    "https://api.modworkshop.net/users/1/roles" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"role_ids\": [
        86
    ]
}"

Delete User Mods

DELETE

https://api.modworkshop.net

/users/{user_id}/mods

requires authentication

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_id

integer

required

The ID of the user.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.modworkshop.net/users/1/mods" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Delete User Discussions

DELETE

https://api.modworkshop.net

/users/{user_id}/discussions

requires authentication

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_id

integer

required

The ID of the user.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.modworkshop.net/users/1/discussions" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

POST users/{user_id}/purge

POST

https://api.modworkshop.net

/users/{user_id}/purge

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_id

integer

required

The ID of the user.

Example:

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.modworkshop.net/users/1/purge" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Report User

POST

https://api.modworkshop.net

/users/{user_id}/reports

requires authentication

Reports the user for moderators to look at it.

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_id

integer

required

The ID of the user.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.modworkshop.net/users/1/reports" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Roles

Get Role

GET

https://api.modworkshop.net

/roles/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the role.

Example:

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.modworkshop.net/roles/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Edit Role

PUT

PATCH

https://api.modworkshop.net

/roles/{id}

requires authentication

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the role.

Example:

Body Parameters

name

string

Must be at least 2 characters. Must not be greater than 30 characters.

Example:

urkddhpyulhyy

tag

string

Must be at least 2 characters. Must not be greater than 30 characters.

Example:

itzazy

desc

string

Must not be greater than 1000 characters.

Example:

xezuhiuwp

color

string

Must not be greater than 8 characters.

Example:

rrhs

is_vanity

boolean

self_assignable

boolean

order

integer

Must not be greater than 1001.

Example:

permissions

object

Auth

Bearer

Headers

URL Parameters

Body

{ "name": "urkddhpyulhyy", "tag": "itzazy", "desc": "xezuhiuwp", "color": "rrhs", "is_vanity": false, "self_assignable": false, "order": 24, "permissions": null }

Received response

Example request:

curl --request PUT \
    "https://api.modworkshop.net/roles/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"urkddhpyulhyy\",
    \"tag\": \"itzazy\",
    \"desc\": \"xezuhiuwp\",
    \"color\": \"rrhs\",
    \"is_vanity\": false,
    \"self_assignable\": false,
    \"order\": 24
}"

Delete Role

DELETE

https://api.modworkshop.net

/roles/{id}

requires authentication

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the role.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.modworkshop.net/roles/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Endpoints

Display a listing of the resource.

GET

https://api.modworkshop.net

/games/{game_id}/mod-managers

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

game_id

integer

required

The ID of the game.

Example:

Body Parameters

query

string

Must not be greater than 150 characters.

Example:

qjofwochzsbzfinkd

limit

integer

Must be at least 1. Must not be greater than 50.

Example:

Headers

URL Parameters

Body

{ "query": "qjofwochzsbzfinkd", "limit": 14 }

Received response

Example request:

curl --request GET \
    --get "https://api.modworkshop.net/games/2/mod-managers" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"query\": \"qjofwochzsbzfinkd\",
    \"limit\": 14
}"

Example response:

Store a newly created resource in storage.

POST

https://api.modworkshop.net

/games/{game_id}/mod-managers

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

game_id

integer

required

The ID of the game.

Example:

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.modworkshop.net/games/2/mod-managers" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Documents

Get List of Documents

GET

https://api.modworkshop.net

/games/{game_id}/documents

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

game_id

integer

required

The ID of the game.

Example:

Body Parameters

query

string

Must not be greater than 150 characters.

Example:

rhkxnlxetqoag

limit

integer

Must be at least 1. Must not be greater than 50.

Example:

Headers

URL Parameters

Body

{ "query": "rhkxnlxetqoag", "limit": 8 }

Received response

Example request:

curl --request GET \
    --get "https://api.modworkshop.net/games/2/documents" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"query\": \"rhkxnlxetqoag\",
    \"limit\": 8
}"

Example response:

Create Document

POST

https://api.modworkshop.net

/games/{game_id}/documents

requires authentication

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

game_id

integer

required

The ID of the game.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.modworkshop.net/games/2/documents" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Get Document

GET

https://api.modworkshop.net

/documents/{document}

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

document

integer

required

The document.

Example:

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.modworkshop.net/documents/8" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Edit Document

PUT

PATCH

https://api.modworkshop.net

/documents/{id}

requires authentication

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the document.

Example:

Body Parameters

name

string

Must be at least 3 characters. Must not be greater than 150 characters.

Example:

igtxftqyzefxvait

desc

string

Must be at least 3 characters. Must not be greater than 50000 characters.

Example:

lcjr

is_unlisted

boolean

Example:

game_id

integer

Must be at least 1.

Example:

url_name

string

Must contain only letters, numbers, dashes and underscores. Must not be greater than 30 characters.

Example:

vjhunrkogwvs

Auth

Bearer

Headers

URL Parameters

Body

{ "name": "igtxftqyzefxvait", "desc": "lcjr", "is_unlisted": true, "game_id": 10, "url_name": "vjhunrkogwvs" }

Received response

Example request:

curl --request PUT \
    "https://api.modworkshop.net/documents/16" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"igtxftqyzefxvait\",
    \"desc\": \"lcjr\",
    \"is_unlisted\": true,
    \"game_id\": 10,
    \"url_name\": \"vjhunrkogwvs\"
}"

Delete Document

DELETE

https://api.modworkshop.net

/documents/{id}

requires authentication

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the document.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.modworkshop.net/documents/19" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Forum

Get Forum

GET

https://api.modworkshop.net

/forums/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the forum.

Example:

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.modworkshop.net/forums/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Forums

Get List of Forum Categories

GET

https://api.modworkshop.net

/games/{game_id}/forum-categories

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

game_id

integer

required

The ID of the game.

Example:

Body Parameters

query

string

Must not be greater than 150 characters.

Example:

yecdctqupb

limit

integer

Must be at least 1. Must not be greater than 50.

Example:

Headers

URL Parameters

Body

{ "query": "yecdctqupb", "limit": 3 }

Received response

Example request:

curl --request GET \
    --get "https://api.modworkshop.net/games/2/forum-categories" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"query\": \"yecdctqupb\",
    \"limit\": 3
}"

Example response:

Create Forum Category

POST

https://api.modworkshop.net

/games/{game_id}/forum-categories

requires authentication

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

game_id

integer

required

The ID of the game.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.modworkshop.net/games/2/forum-categories" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Get Forum Category

GET

https://api.modworkshop.net

/forum-categories/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the forum category.

Example:

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.modworkshop.net/forum-categories/6" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Edit Forum Category

PUT

PATCH

https://api.modworkshop.net

/forum-categories/{id}

requires authentication

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the forum category.

Example:

Body Parameters

name

string

Must be at least 3 characters. Must not be greater than 150 characters.

Example:

nhgqyeujlbhcpfpsnsfw

emoji

string

Must not be greater than 6 characters.

Example:

fqsisn

desc

string

Must not be greater than 1000 characters.

Example:

bareufmvotpg

is_private

boolean

banned_can_post

boolean

Example:

private_threads

boolean

role_policies

object

game_role_policies

object

display_order

integer

Must be at least -1000. Must not be greater than 1000.

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "name": "nhgqyeujlbhcpfpsnsfw", "emoji": "fqsisn", "desc": "bareufmvotpg", "is_private": false, "banned_can_post": true, "private_threads": false, "role_policies": null, "game_role_policies": null, "display_order": 23 }

Received response

Example request:

curl --request PUT \
    "https://api.modworkshop.net/forum-categories/10" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"nhgqyeujlbhcpfpsnsfw\",
    \"emoji\": \"fqsisn\",
    \"desc\": \"bareufmvotpg\",
    \"is_private\": false,
    \"banned_can_post\": true,
    \"private_threads\": false,
    \"display_order\": 23
}"

Delete Forum Category

DELETE

https://api.modworkshop.net

/forum-categories/{id}

requires authentication

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the forum category.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.modworkshop.net/forum-categories/15" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Instructions Templates

Get list of Instructions Templates

GET

https://api.modworkshop.net

/games/{game_id}/instructs-templates

requires authentication

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

game_id

integer

required

The ID of the game.

Example:

Body Parameters

query

string

Must not be greater than 150 characters.

Example:

ecempxcvooafblqrjlpcy

limit

integer

Must be at least 1. Must not be greater than 50.

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "query": "ecempxcvooafblqrjlpcy", "limit": 20 }

Received response

Example request:

curl --request GET \
    --get "https://api.modworkshop.net/games/2/instructs-templates" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"query\": \"ecempxcvooafblqrjlpcy\",
    \"limit\": 20
}"

Example response:

Create Instructions Template

POST

https://api.modworkshop.net

/games/{game_id}/instructs-templates

requires authentication

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

game_id

integer

required

The ID of the game.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.modworkshop.net/games/2/instructs-templates" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Reports

Get List of Reports

GET

https://api.modworkshop.net

/games/{game_id}/reports

requires authentication

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

game_id

integer

required

The ID of the game.

Example:

Body Parameters

query

string

Must not be greater than 150 characters.

Example:

gwmndpm

limit

integer

Must be at least 1. Must not be greater than 50.

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "query": "gwmndpm", "limit": 22 }

Received response

Example request:

curl --request GET \
    --get "https://api.modworkshop.net/games/2/reports" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"query\": \"gwmndpm\",
    \"limit\": 22
}"

Example response:

Threads

Get List of Threads

GET

https://api.modworkshop.net

/forums/{forum_id}/threads

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

forum_id

integer

required

The ID of the forum.

Example:

Body Parameters

query

string

Must not be greater than 150 characters.

Example:

tdxek

limit

integer

Must be at least 1. Must not be greater than 50.

Example:

category_name

string

Must not be greater than 100 characters.

Example:

htntrorcmjo

category_id

integer

Must be at least 1.

Example:

tags

integer[]

Must be at least 1.

Example:

[56]

no_pins

boolean

forum_id

integer

Must be at least 1.

Example:

Headers

URL Parameters

Body

{ "query": "tdxek", "limit": 7, "category_name": "htntrorcmjo", "category_id": 24, "tags": [ 56 ], "no_pins": false, "forum_id": 52 }

Received response

Example request:

curl --request GET \
    --get "https://api.modworkshop.net/forums/1/threads" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"query\": \"tdxek\",
    \"limit\": 7,
    \"category_name\": \"htntrorcmjo\",
    \"category_id\": 24,
    \"tags\": [
        56
    ],
    \"no_pins\": false,
    \"forum_id\": 52
}"

Example response:

Create Thread

POST

https://api.modworkshop.net

/forums/{forum_id}/threads

requires authentication

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

forum_id

integer

required

The ID of the forum.

Example:

Body Parameters

name

string

Must be at least 3 characters. Must not be greater than 150 characters.

Example:

awqznvkccnffkbstbizkeif

content

string

required

Must be at least 2 characters. Must not be greater than 30000 characters.

Example:

yfswvaxubbginaawfbcfb

announce_until

string

Must be a valid date.

Example:

2024-07-19T00:21:26

announce

boolean

Example:

category_id

integer

Must be at least 1.

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "name": "awqznvkccnffkbstbizkeif", "content": "yfswvaxubbginaawfbcfb", "announce_until": "2024-07-19T00:21:26", "announce": true, "category_id": 55 }

Received response

Example request:

curl --request POST \
    "https://api.modworkshop.net/forums/1/threads" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"awqznvkccnffkbstbizkeif\",
    \"content\": \"yfswvaxubbginaawfbcfb\",
    \"announce_until\": \"2024-07-19T00:21:26\",
    \"announce\": true,
    \"category_id\": 55
}"

Get Thread

GET

https://api.modworkshop.net

/threads/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the thread.

Example:

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://api.modworkshop.net/threads/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Edit Thread

PUT

PATCH

https://api.modworkshop.net

/threads/{id}

requires authentication

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the thread.

Example:

Body Parameters

name

string

Must be at least 3 characters. Must not be greater than 150 characters.

Example:

wdoomnbduqqcifwgzbch

content

string

Must be at least 2 characters. Must not be greater than 30000 characters.

Example:

wdym

category_id

integer

Must be at least 1.

Example:

answer_comment_id

integer

Must be at least 1.

Example:

announce_until

string

Must be a valid date.

Example:

2024-07-19T00:21:26

announce

boolean

Example:

tag_ids

integer[]

Must be at least 1.

Example:

[81]

pinned

boolean

Example:

locked

boolean

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "name": "wdoomnbduqqcifwgzbch", "content": "wdym", "category_id": 76, "answer_comment_id": 13, "announce_until": "2024-07-19T00:21:26", "announce": true, "tag_ids": [ 81 ], "pinned": true, "locked": true }

Received response

Example request:

curl --request PUT \
    "https://api.modworkshop.net/threads/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"wdoomnbduqqcifwgzbch\",
    \"content\": \"wdym\",
    \"category_id\": 76,
    \"answer_comment_id\": 13,
    \"announce_until\": \"2024-07-19T00:21:26\",
    \"announce\": true,
    \"tag_ids\": [
        81
    ],
    \"pinned\": true,
    \"locked\": true
}"

Delete Thread

DELETE

https://api.modworkshop.net

/threads/{id}

requires authentication

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the thread.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.modworkshop.net/threads/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Report Thread

POST

https://api.modworkshop.net

/threads/{thread_id}/reports

requires authentication

Reports the thread for moderators to look at it.

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

thread_id

integer

required

The ID of the thread.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.modworkshop.net/threads/1/reports" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Comments

Get List of Thread Comments

GET

https://api.modworkshop.net

/threads/{thread_id}/comments

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

thread_id

integer

required

The ID of the thread.

Example:

Body Parameters

query

string

Must not be greater than 150 characters.

Example:

lwmtfwqrewqgdbbmlldl

limit

integer

Must be at least 1. Must not be greater than 50.

Example:

Headers

URL Parameters

Body

{ "query": "lwmtfwqrewqgdbbmlldl", "limit": 16 }

Received response

Example request:

curl --request GET \
    --get "https://api.modworkshop.net/threads/1/comments" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"query\": \"lwmtfwqrewqgdbbmlldl\",
    \"limit\": 16
}"

Example response:

Create Thread Comment

POST

https://api.modworkshop.net

/threads/{thread_id}/comments

requires authentication

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

thread_id

integer

required

The ID of the thread.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.modworkshop.net/threads/1/comments" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Subscribe to Thread Comment

POST

https://api.modworkshop.net

/threads/{thread_id}/comments/subscription

requires authentication

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

thread_id

integer

required

The ID of the thread.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.modworkshop.net/threads/1/comments/subscription" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Unsubscribe to Thread Comment

DELETE

https://api.modworkshop.net

/threads/{thread_id}/comments/subscription

requires authentication

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

thread_id

integer

required

The ID of the thread.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.modworkshop.net/threads/1/comments/subscription" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"