(Translated by https://www.hiragana.jp/)
MangaUpdates API
API docs by Redocly

MangaUpdates API (1.0.0)

This API powers our website. Most API functions are public and do not require an account. For user-based functions, you must register an account. Currently, user registration must be done through our main website and is disabled via this API.

Download OpenAPI Specification: openapi.yaml

Please contact us at the following emails if you have questions:

Warranties

MangaUpdates makes no warranties about service availability, correctness of the data, or anything else. The service is provided as is, and may change at any time.

Acceptable Use Policy

  • You will credit MangaUpdates when using data provided by this API.
  • You will use reasonable spacing between requests so as not to overwhelm the MangaUpdates servers, and employ caching mechanisms when accessing data.
  • You will NOT use MangaUpdates data or API in a way that will:
    • Deceive or defraud users
    • Assist or perform an illegal action
    • Create spam
    • Damage the database

We reserve the right to change this policy at any time.

aboutus

add a category

Authorizations:
bearerAuth
Request Body schema: application/json
required
title
string (title)

Responses

Request samples

Content type
application/json
{
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "context": { }
}

returns a single category

Authorizations:
bearerAuth
path Parameters
category_id
required
integer

Aboutus Category id

query Parameters
unrenderedFields
boolean

Output fields in unrendered form for editing

Responses

Response samples

Content type
application/json
{
  • "category_id": 0,
  • "position": 0,
  • "title": "string",
  • "users": [
    ]
}

remove a category

Authorizations:
bearerAuth
path Parameters
category_id
required
integer

Aboutus Category id

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "context": { }
}

update a category

Authorizations:
bearerAuth
path Parameters
category_id
required
integer

id of category

Request Body schema: application/json
required
title
string (title)

Responses

Request samples

Content type
application/json
{
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "context": { }
}

returns categories and users

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

returns description of site

Authorizations:
bearerAuth
query Parameters
unrenderedFields
boolean

Output fields in unrendered form for editing

Responses

Response samples

Content type
application/json
{
  • "description": "string"
}

update description of site

Authorizations:
bearerAuth
Request Body schema: application/json
required
description
string (description)

Responses

Request samples

Content type
application/json
{
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "context": { }
}

reorder aboutus

Authorizations:
bearerAuth
Request Body schema: application/json
required
Array
category_id
required
integer (category_id)
position
integer (position)
Array of objects (users)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "context": { }
}

add a user to a category

Authorizations:
bearerAuth
path Parameters
category_id
required
integer

Aboutus Category id

Request Body schema: application/json
required
username
string (username)

Responses

Request samples

Content type
application/json
{
  • "username": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "context": { }
}

remove a user from a category

Authorizations:
bearerAuth
path Parameters
category_id
required
integer

Aboutus Category id

entry_id
required
integer

Aboutus Category User Entry id

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "context": { }
}

account

retrieve the public captcha key

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "context": { }
}

confirm deletion of your account

Authorizations:
bearerAuth
path Parameters
auth_hash
required
string

auth hash from email confirmation

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "context": { }
}

delete your account

Authorizations:
bearerAuth
path Parameters
captcha_response
required
string

response of captcha

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "context": { }
}

update a password change using an auth hash

Authorizations:
bearerAuth
path Parameters
auth_hash
required
string

auth hash from email confirmation

Request Body schema: application/json
required
password
string <password> (password)

Responses

Request samples

Content type
application/json
{
  • "password": "pa$$word"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "context": { }
}

send a forgotten password email

Authorizations:
bearerAuth
path Parameters
captcha_response
required
string

response of captcha

Request Body schema: application/json
required
email
string (email)

Responses

Request samples

Content type
application/json
{
  • "email": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "context": { }
}

create a session token

Authorizations:
bearerAuth
Request Body schema: application/json
required
username
string (username)
password
string <password> (password)

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "pa$$word"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "context": { }
}

remove a session token

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "context": { }
}

get the profile for the current user

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "user_id": 0,
  • "username": "string",
  • "url": "string",
  • "email": "string",
  • "avatar": {
    },
  • "time_joined": {
    },
  • "last_active_time": {
    },
  • "gender": "N/A",
  • "birthday": {
    },
  • "age": 0,
  • "timezone": 0,
  • "signature": "string",
  • "location": "string",
  • "forum_title": "string",
  • "folding_at_home": true,
  • "profile": {
    },
  • "stats": {
    },
  • "admin": {
    },
  • "user_group": "string",
  • "user_group_name": "string"
}

confirm a new member registration

Authorizations:
bearerAuth
path Parameters
auth_hash
required
string

auth hash from email confirmation

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "context": { }
}

register a new member

Authorizations:
bearerAuth
path Parameters
captcha_response
required
string

response of captcha

Request Body schema: application/json
required
username
string (username)
email
string (email)
password
string <password> (password)

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "email": "string",
  • "password": "pa$$word"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "context": { }
}

send an auth email to a user

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

Member id

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "context": { }
}

send a forgotten password email to a user

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

Member id

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "context": { }
}

authors

add an author

Authorizations:
bearerAuth
Request Body schema: application/json
required
name
string (name)
Array of objects (associated)
actualname
string (actualname)
object (BirthdayModelV1)
birthplace
string (birthplace)
bloodtype
string (bloodtype)
Enum: "N/A" "A" "B" "AB" "O"
gender
string (gender)
Enum: "N/A" "Male" "Female" "Other"
status
string (status)
Enum: "N/A" "Active" "Temporarily Inactive" "Retired" "Deceased"
object (StatusDateModelV1)
object (AuthorsModelUpdateV1Social)
comments
string (comments)
object (AuthorsModelUpdateV1Admin)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "associated": [
    ],
  • "actualname": "string",
  • "birthday": {
    },
  • "birthplace": "string",
  • "bloodtype": "N/A",
  • "gender": "N/A",
  • "status": "N/A",
  • "status_date": {
    },
  • "social": {
    },
  • "comments": "string",
  • "admin": {
    }
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "context": { }
}

get a specific author

Authorizations:
bearerAuth
path Parameters
id
required
integer

Author id

query Parameters
unrenderedFields
boolean

Output fields in unrendered form for editing

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "url": "string",
  • "associated": [
    ],
  • "image": {
    },
  • "actualname": "string",
  • "birthday": {
    },
  • "birthplace": "string",
  • "bloodtype": "N/A",
  • "gender": "N/A",
  • "status": "N/A",
  • "status_date": {
    },
  • "genres": [
    ],
  • "stats": {
    },
  • "social": {
    },
  • "comments": "string",
  • "last_updated": {
    },
  • "added_by": {
    },
  • "admin": {
    }
}

delete an author

Authorizations:
bearerAuth
path Parameters
id
required
integer

id of author

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "context": { }
}

update an author

Authorizations:
bearerAuth
path Parameters
id
required
integer

id of author

Request Body schema: application/json
required
name
string (name)
Array of objects (associated)
actualname
string (actualname)
object (BirthdayModelV1)
birthplace
string (birthplace)
bloodtype
string (bloodtype)
Enum: "N/A" "A" "B" "AB" "O"
gender
string (gender)
Enum: "N/A" "Male" "Female" "Other"
status
string (status)
Enum: "N/A" "Active" "Temporarily Inactive" "Retired" "Deceased"
object (StatusDateModelV1)
object (AuthorsModelUpdateV1Social)
comments
string (comments)
object (AuthorsModelUpdateV1Admin)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "associated": [
    ],
  • "actualname": "string",
  • "birthday": {
    },
  • "birthplace": "string",
  • "bloodtype": "N/A",
  • "gender": "N/A",
  • "status": "N/A",
  • "status_date": {
    },
  • "social": {
    },
  • "comments": "string",
  • "admin": {
    }
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "context": { }
}

get locks for a specific author

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

Author id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

lock a field of an author

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

id of author

item
required
string

field name

Request Body schema: application/json
required
reason
string (reason)

Responses

Request samples

Content type
application/json
{
  • "reason": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "context": { }
}

unlock a field of an author

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

id of author

item
required
string

field name

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "context": { }
}

search authors

Authorizations:
bearerAuth
Request Body schema: application/json
required
search
string (search)
added_by
integer (added_by)
page
integer (page)
perpage
integer (perpage)
letter
string (letter)
genre
Array of strings (genre)
orderby
string (orderby)
Enum: "name" "series" "score"
pending
boolean (pending)

Responses

Request samples

Content type
application/json
{
  • "search": "string",
  • "added_by": 0,
  • "page": 0,
  • "perpage": 0,
  • "letter": "string",
  • "genre": [
    ],
  • "orderby": "name",
  • "pending": true
}

Response samples

Content type
application/json
{
  • "total_hits": 0,
  • "page": 0,
  • "per_page": 0,
  • "results": [
    ]
}

get the list of series for a specific author

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

Author id

Request Body schema: application/json
required
orderby
string (orderby)
Enum: "title" "year"

Responses

Request samples

Content type
application/json
{
  • "orderby": "title"
}

Response samples

Content type
application/json
{
  • "total_series": 0,
  • "series_list": [
    ],
  • "genre_list": [
    ]
}

update the image of an author

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

id of author

Request Body schema: multipart/form-data
image
string <binary>

Image to update

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "context": { }
}

delete the image of an author

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

id of author

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "context": { }
}

categories

combine two categories across the database

Authorizations:
bearerAuth
Request Body schema: application/json
required
object (CategoriesModelUpdateV1)
object (CategoriesModelUpdateV1)

Responses

Request samples

Content type
application/json
{
  • "from": {
    },
  • "to": {
    }
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "context": { }
}

delete a category across the database

Authorizations:
bearerAuth
Request Body schema: application/json
required
category
string (category)

Responses

Request samples

Content type
application/json
{
  • "category": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "context": { }
}

find a category by prefix

Authorizations:
bearerAuth
Request Body schema: application/json
required
category
string (category)

Responses

Request samples

Content type
application/json
{
  • "category": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

find a category by name

Authorizations:
bearerAuth
Request Body schema: application/json
required
category
string (category)

Responses

Request samples

Content type
application/json
{
  • "category": "string"
}

Response samples

Content type
application/json
{
  • "series_id": 0,
  • "category": "string",
  • "votes": 0,
  • "votes_plus": 0,
  • "votes_minus": 0,
  • "added_by": 0
}

search categories

Authorizations:
bearerAuth
Request Body schema: application/json
required
search
string (search)
page
integer (page)
perpage
integer (perpage)
letter
string (letter)
orderby
string (orderby)
Enum: "category" "agree" "disagree" "usage"

Responses

Request samples

Content type
application/json
{
  • "search": "string",
  • "page": 0,
  • "perpage": 0,
  • "letter": "string",
  • "orderby": "category"
}

Response samples

Content type
application/json
{
  • "total_hits": 0,
  • "page": 0,
  • "per_page": 0,
  • "results": [
    ]
}

convo

add an convo

Authorizations:
bearerAuth
Request Body schema: application/json
required
topic
string (topic)
Array of objects (participants)
object (ConvoMessageModelUpdateV1)

Responses

Request samples

Content type
application/json
{
  • "topic": "string",
  • "participants": [
    ],
  • "message": {
    }
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "context": { }
}

abandon convos in bulk

Authorizations:
bearerAuth
Request Body schema: application/json
required
convo_id_list
Array of integers (convo_id_list)

Responses

Request samples

Content type
application/json
{
  • "convo_id_list": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "context": { }
}

delete convos in bulk

Authorizations:
bearerAuth
Request Body schema: application/json
required
convo_id_list
Array of integers (convo_id_list)

Responses

Request samples

Content type
application/json
{
  • "convo_id_list": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "context": { }
}

get a specific convo

Authorizations:
bearerAuth
path Parameters
id
required
integer

Convo id

query Parameters
unrenderedFields
boolean

Output fields in unrendered form for editing

Responses

Response samples

Content type
application/json
{
  • "convo_id": 0,
  • "topic": "string",
  • "author_id": 0,
  • "author_name": "string",
  • "time_added": {
    },
  • "last_edit": {
    }
}

delete a convo

Authorizations:
bearerAuth
path Parameters
id
required
integer

Convo id

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "context": { }
}

update a convo

Authorizations:
bearerAuth
path Parameters
id
required
integer

Convo id

Request Body schema: application/json
required
topic
string (topic)

Responses

Request samples

Content type
application/json
{
  • "topic": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "context": { }
}

return whether the user is ignored

Authorizations:
bearerAuth
path Parameters
user_id
required
integer

User id

Responses

Response samples

Content type
application/json
{
  • "user_ignored": true
}

ignore a user

Authorizations:
bearerAuth
path Parameters
user_id
required
integer

User id

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "context": { }
}

remove ignore for a user

Authorizations:
bearerAuth
path Parameters
user_id
required
integer

User id

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "context": { }
}

display unread messages

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "total_hits": 0,
  • "page": 0,
  • "per_page": 0,
  • "results": [
    ]
}

retrieve number of unread messages

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "total_hits": 0,
  • "page": 0,
  • "per_page": 0,
  • "results": [
    ]
}

display sent messages

Authorizations:
bearerAuth
Request Body schema: application/json
required
page
integer (page)
perpage
integer (perpage)

Responses

Request samples

Content type
application/json
{
  • "page": 0,
  • "perpage": 0
}

Response samples

Content type
application/json
{
  • "total_hits": 0,
  • "page": 0,
  • "per_page": 0,
  • "results": [
    ]
}

display received (and read) messages

Authorizations:
bearerAuth
Request Body schema: application/json
required
page
integer (page)
perpage
integer (perpage)

Responses

Request samples

Content type
application/json
{
  • "page": 0,
  • "perpage": 0
}

Response samples

Content type
application/json
{
  • "total_hits": 0,
  • "page": 0,
  • "per_page": 0,
  • "results": [
    ]
}

add a message to a convo

Authorizations:
bearerAuth
path Parameters
id
required
integer

Convo id

Request Body schema: application/json
required
content
string (content)

Responses

Request samples

Content type
application/json
{
  • "content": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "context": { }
}

list convo messages

Authorizations:
bearerAuth
path Parameters
id
required
integer

Convo id

Request Body schema: application/json
required
page
integer (page)
perpage
integer (perpage)

Responses

Request samples

Content type
application/json
{
  • "page": 0,
  • "perpage": 0
}

Response samples

Content type
application/json
{
  • "total_hits": 0,
  • "page": 0,
  • "per_page": 0,
  • "results": [
    ]
}

get a specific convo message

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

Convo id

message_id
required
integer <int64>

Convo message id

query Parameters
unrenderedFields
boolean

Output fields in unrendered form for editing

Responses

Response samples

Content type
application/json
{
  • "message_id": 0,
  • "convo_id": 0,
  • "author_id": 0,
  • "author_name": "string",
  • "is_admin": true,
  • "content": "string",
  • "time_added": {
    },
  • "last_edit": {
    }
}

update a convo message

Authorizations:
bearerAuth
path Parameters
id
required
integer

Convo id

message_id
required
integer

Convo message id

Request Body schema: application/json
required
content
string (content)

Responses

Request samples

Content type
application/json
{
  • "content": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "context": { }
}

get a specific convo message location

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

Convo id

message_id
required
integer <int64>

Convo message id

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "context": { }
}

search convo

Authorizations:
bearerAuth
path Parameters
id
required
integer

Convo id

Request Body schema: application/json
required
search
string (search)
added_by
integer (added_by)
page
integer (page)
perpage
integer (perpage)

Responses

Request samples

Content type
application/json
{
  • "search": "string",
  • "added_by": 0,
  • "page": 0,
  • "perpage": 0
}

Response samples

Content type
application/json
{
  • "total_hits": 0,
  • "page": 0,
  • "per_page": 0,
  • "results": [
    ]
}

abandon a convo

Authorizations:
bearerAuth
path Parameters
id
required
integer

Convo id

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "context": { }
}

invite a user to a convo

Authorizations:
bearerAuth
path Parameters
id
required
integer

Convo id

Request Body schema: application/json
required
Array
to
string (to)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "context": { }
}

join a convo

Authorizations:
bearerAuth
path Parameters
id
required
integer

Convo id

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "context": { }
}

kick a user from a convo

Authorizations:
bearerAuth
path Parameters
id
required
integer

Convo id

user_id
required
integer

User id

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "context": { }
}

get list of convo participants

Authorizations:
bearerAuth
path Parameters
id
required
integer

Convo id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

search convo

Authorizations:
bearerAuth
Request Body schema: application/json
required
search
string (search)
page
integer (page)
perpage
integer (perpage)

Responses

Request samples

Content type
application/json
{
  • "search": "string",
  • "page": 0,
  • "perpage": 0
}

Response samples

Content type
application/json
{
  • "total_hits": 0,
  • "page": 0,
  • "per_page": 0,
  • "results": [
    ]
}

faq

retrieve all categories and questions

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

add a faq category

Authorizations:
bearerAuth
Request Body schema: application/json
required
title
string (title)

Responses

Request samples

Content type
application/json
{
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "context": { }
}

get a specific category

Authorizations:
bearerAuth
path Parameters
category_id
required
integer

Faq category id

query Parameters
unrenderedFields
boolean

Output fields in unrendered form for editing

Responses

Response samples

Content type
application/json
{
  • "category_id": 0,
  • "title": "string",
  • "position": 0
}

delete a faq category

Authorizations:
bearerAuth
path Parameters
category_id
required
integer

id of faq category

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "context": { }
}

update a faq category

Authorizations:
bearerAuth
path Parameters
category_id
required
integer

id of faq category

Request Body schema: application/json
required
title
string (title)

Responses

Request samples

Content type
application/json
{
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "context": { }
}

retrieve all quesitons for a category

Authorizations:
bearerAuth
path Parameters
category_id
required
integer

Faq category id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

add a faq question

Authorizations:
bearerAuth
path Parameters
category_id
required
integer

id of category to add question to

Request Body schema: application/json
required
question
string (question)
answer
string (answer)

Responses

Request samples

Content type
application/json
{
  • "question": "string",
  • "answer": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "context": { }
}

get a specific question for a category

Authorizations:
bearerAuth
path Parameters
category_id
required
integer

Faq category id

question_id
required
integer

Faq question id

query Parameters
unrenderedFields
boolean

Output fields in unrendered form for editing

Responses

Response samples

Content type
application/json
{
  • "question_id": 0,
  • "question": "string",
  • "answer": "string",
  • "position": 0
}

delete an faq

Authorizations:
bearerAuth
path Parameters
category_id
required
integer

Faq category id

question_id
required
integer

Faq question id

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "context": { }
}

update a faq question

Authorizations:
bearerAuth
path Parameters
category_id
required
integer

Faq category id

question_id
required
integer

Faq question id

Request Body schema: application/json
required
question
string (question)
answer
string (answer)

Responses

Request samples

Content type
application/json
{
  • "question": "string",
  • "answer": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "context": { }
}

reorder faq

Authorizations:
bearerAuth
Request Body schema: application/json
required
Array
category_id
required
integer (category_id)
position
integer (position)
Array of objects (questions)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "context": { }
}

forum

add a forum admin

Authorizations:
bearerAuth
path Parameters
forum_id
required
integer

Forum id

user_id
required
integer

User id

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "context": { }
}

remove a forum admin

Authorizations:
bearerAuth
path Parameters
forum_id
required
integer

Forum id

user_id
required
integer

User id

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "context": { }
}

retrieve a forum

Authorizations:
bearerAuth
path Parameters
forum_id
required
integer

Forum id

query Parameters
unrenderedFields
boolean

Output fields in unrendered form for editing

Responses

Response samples

Content type
application/json
{
  • "forum_id": 0,
  • "name": "string",
  • "url": "string",
  • "description": "string",
  • "position": 0,
  • "category": {
    },
  • "moderators": [
    ],
  • "series": {
    },
  • "stats": {
    },
  • "last_topic": {
    },
  • "admin": {
    }
}

add a forum topic

Authorizations:
bearerAuth
path Parameters
forum_id
required
integer

Forum id

Request Body schema: application/json
required
object (ForumTopicModelUpdateV1)
object (ForumPostModelUpdateV1)
object (ForumPollModelUpdateV1)

Responses

Request samples

Content type
application/json
{
  • "topic": {
    },
  • "post": {
    },
  • "poll": {
    }
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "reason": "string",
  • "context": { }
}

show forum admin log

Authorizations:
bearerAuth
Request Body schema: application/json
required
page
integer (page)
perpage
integer (perpage)
uid
integer (uid)

Responses

Request samples

Content type
application/json
{
  • "page": 0,
  • "perpage": 0,
  • "uid": 0
}

Response samples

Content type
application/json
{
  • "total_hits": 0,
  • "page": 0,
  • "per_page": 0,
  • "results": [
    ]
}

show forum categories and forums

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

show popular forums

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

list posts in topic that I made

Authorizations:
bearerAuth
path Parameters
forum_id
required
integer

Forum id

topic_id
required
integer

Topic id

Responses

Response samples

Content type
application/json
{
  • "topic_id": 0,
  • "post_id_list": [
    ]
}

list posts in topic

Authorizations:
bearerAuth
path Parameters
forum_id
required
integer

Forum id

topic_id
required
integer

Topic id

Request Body schema: application/json
required
page
integer (page)
perpage
integer (perpage)

Responses

Request samples

Content type
application/json
{
  • "page": 0,
  • "perpage": 0
}

Response samples

Content type
application/json
{
  • "total_hits": 0,
  • "page": 0,
  • "per_page": 0,
  • "results": [
    ]
}

list topics

Authorizations:
bearerAuth
path Parameters
forum_id
required
integer

Forum id

query Parameters
with_first_post
boolean

Also return the first post of each topic

Request Body schema: application/json
required
page
integer (page)
perpage
integer (perpage)
orderby
string (orderby)
Enum: "last_post_date" "topic_start_date"

Responses

Request samples

Content type
application/json
{
  • "page": 0,
  • "perpage": 0,
  • "orderby": "last_post_date"
}

Response samples

Content type
application/json
{
  • "total_hits": 0,
  • "page": 0,
  • "per_page": 0,
  • "results": [
    ]
}

list global topics

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "total_hits": 0,
  • "page": 0,
  • "per_page": 0,
  • "results": [