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

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

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
required
string (username)
password
required
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": {
    }
}

create a session token as a cookie

Authorizations:
bearerAuth
Request Body schema: application/json
required
username
required
string (username)
password
required
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"
}

refresh session token cookie

Authorizations:
bearerAuth

Responses

Response samples

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

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

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

categories

combine two categories across the database

Authorizations:
bearerAuth
Request Body schema: application/json
required
required
object (SeriesCategoryUpdateModelV1From)
required
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
required
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
required
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
required
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

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",
  • "author_url": "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",
  • "author_url": "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
required
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

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

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": [
    ]
}

lookup a series to find the forum id

Authorizations:
bearerAuth
path Parameters
series_id
required
integer

Series id

Responses

Response samples

Content type
application/json
{
  • "topic_id": 0,
  • "forum_id": 0
}

lookup a topic to find the forum id

Authorizations:
bearerAuth
path Parameters
topic_id
required
integer

Topic id

Responses

Response samples

Content type
application/json
{
  • "topic_id": 0,
  • "forum_id": 0
}

lookup a post to find the forum and topic id

Authorizations:
bearerAuth
path Parameters
post_id
required
integer

Post id

Responses

Response samples

Content type
application/json
{
  • "topic_id": 0,
  • "forum_id": 0
}

retrieve temporary poll images

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

add a temporary poll image

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

Image to update

caption
string

Image caption

Responses

Response samples

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

update a forum topic poll (if present)

Authorizations:
bearerAuth
path Parameters
forum_id
required
integer

Forum id

topic_id
required
integer

Topic id

Request Body schema: application/json
required
question
string (question)
Array of objects (answers)

Responses

Request samples

Content type
application/json
{
  • "question": "string",
  • "answers": [
    ]
}

Response samples

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

add a vote to a forum poll

Authorizations:
bearerAuth
path Parameters
forum_id
required
integer

Forum id

topic_id
required
integer

Topic id

choice_id
required
integer

Choice id

Responses

Response samples

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

retrieve my vote from the poll

Authorizations:
bearerAuth
path Parameters
forum_id
required
integer

Forum id

topic_id
required
integer

Topic id

Responses

Response samples

Content type
application/json
{
  • "choice_id": 0
}

retrieve a forum topic

Authorizations:
bearerAuth
path Parameters
forum_id
required
integer

Forum id

topic_id
required
integer

Topic id

query Parameters
unrenderedFields
boolean

Output fields in unrendered form for editing

Responses

Response samples

Content type
application/json
{
  • "topic_id": 0,
  • "topic": "string",
  • "url": "string",
  • "last_post": {
    },
  • "stats": {
    },
  • "forum": {
    },
  • "is_poll": true,
  • "poll": {
    },
  • "admin": {
    },
  • "topic_starter": {
    },
  • "time_added": {
    }
}

add a forum post

Authorizations:
bearerAuth
path Parameters
forum_id
required
integer

Forum id

topic_id
required
integer

Topic id

Request Body schema: application/json
required
body
string (body)
reply_to
integer (reply_to)

Responses

Request samples

Content type
application/json
{
  • "body": "string",
  • "reply_to": 0
}

Response samples

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

delete a topic

Authorizations:
bearerAuth
path Parameters
forum_id
required
integer

Forum id

topic_id
required
integer

Topic id

Responses

Response samples

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

update a forum topic

Authorizations:
bearerAuth
path Parameters
forum_id
required
integer

Forum id

topic_id
required
integer

Topic id

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

Responses

Request samples

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

Response samples

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

retrieve a forum post

Authorizations:
bearerAuth
path Parameters
forum_id
required
integer

Forum id

topic_id
required
integer

Topic id

post_id
required
integer

Post id

query Parameters
unrenderedFields
boolean

Output fields in unrendered form for editing

Responses

Response samples

Content type
application/json
{
  • "post_id": 0,
  • "body": "string",
  • "topic": {
    },
  • "author": {
    },
  • "reply_to": {
    },
  • "last_edit": {
    },
  • "time_added": {
    }
}

delete a post

Authorizations:
bearerAuth
path Parameters
forum_id
required
integer

Forum id

topic_id
required
integer

Topic id

post_id
required
integer

Post id

Responses

Response samples

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

update a forum post

Authorizations:
bearerAuth
path Parameters
forum_id
required
integer

Forum id

topic_id
required
integer

Topic id

post_id
required
integer

Post id

Request Body schema: application/json
required
body
string (body)
reply_to
integer (reply_to)

Responses

Request samples

Content type
application/json
{
  • "body": "string",
  • "reply_to": 0
}

Response samples

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

report a forum post

Authorizations:
bearerAuth
path Parameters
forum_id
required
integer

Forum id

topic_id
required
integer

Topic id

post_id
required
integer

Post id

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": {
    }
}

delete a post report

Authorizations:
bearerAuth
path Parameters
forum_id
required
integer

Forum id

topic_id
required
integer

Topic id

post_id
required
integer

Post id

Responses

Response samples

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

show reported posts

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

retrieve a forum post location within topic

Authorizations:
bearerAuth
path Parameters
forum_id
required
integer

Forum id

topic_id
required
integer

Topic id

post_id
required
integer

Post id

Responses

Response samples

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

search forum

Authorizations:
bearerAuth
Request Body schema: application/json
required
search_by
string (search_by)
Enum: "post" "topic"
method
string (method)
Enum: "fulltext" "exact"
search
string (search)
since
integer (since)
after_id
integer (after_id)
before_id
integer (before_id)
page
integer (page)
perpage
integer (perpage)
by_user_id
integer (by_user_id)
filter_user_id
integer (filter_user_id)

Responses

Request samples

Content type
application/json
{
  • "search_by": "post",
  • "method": "fulltext",
  • "search": "string",
  • "since": 0,
  • "after_id": 0,
  • "before_id": 0,
  • "page": 0,
  • "perpage": 0,
  • "by_user_id": 0,
  • "filter_user_id": 0
}

Response samples

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

search specific forum

Authorizations:
bearerAuth
path Parameters
forum_id
required
integer

Forum id

Request Body schema: application/json
required
search_by
string (search_by)
Enum: "post" "topic"
method
string (method)
Enum: "fulltext" "exact"
search
string (search)
since
integer (since)
after_id
integer (after_id)
before_id
integer (before_id)
page
integer (page)
perpage
integer (perpage)
by_user_id
integer (by_user_id)
filter_user_id
integer (filter_user_id)

Responses

Request samples

Content type
application/json
{
  • "search_by": "post",
  • "method": "fulltext",
  • "search": "string",
  • "since": 0,
  • "after_id": 0,
  • "before_id": 0,
  • "page": 0,
  • "perpage": 0,
  • "by_user_id": 0,
  • "filter_user_id": 0
}

Response samples

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

search specific topic

Authorizations:
bearerAuth
path Parameters
forum_id
required
integer

Forum id

topic_id
required
integer

Topic id

Request Body schema: application/json
required
search_by
string (search_by)
Enum: "post" "topic"
method
string (method)
Enum: "fulltext" "exact"
search
string (search)
since
integer (since)
after_id
integer (after_id)
before_id
integer (before_id)
page
integer (page)
perpage
integer (perpage)
by_user_id
integer (by_user_id)
filter_user_id
integer (filter_user_id)

Responses

Request samples

Content type
application/json
{
  • "search_by": "post",
  • "method": "fulltext",
  • "search": "string",
  • "since": 0,
  • "after_id": 0,
  • "before_id": 0,
  • "page": 0,
  • "perpage": 0,
  • "by_user_id": 0,
  • "filter_user_id": 0
}

Response samples

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

show warn history for a user

Authorizations:
bearerAuth
path Parameters
user_id
required
integer

User id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

gets the current warn status for user

Authorizations:
bearerAuth
path Parameters
user_id
required
integer

User id

Responses

Response samples

Content type
application/json
{
  • "user_id": 0,
  • "time_added": {
    },
  • "level": 0,
  • "reason": "string",
  • "send_reason": true,
  • "by_user": {
    }
}

update a user warn level

Authorizations:
bearerAuth
path Parameters
user_id
required
integer

User id

Request Body schema: application/json
required
level
required
integer (level)
reason
required
string (reason)
send_reason
boolean (send_reason)

Responses

Request samples

Content type
application/json
{
  • "level": 0,
  • "reason": "string",
  • "send_reason": true
}

Response samples

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

genre

genre

get genres

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

add a genre

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

Responses

Request samples

Content type
application/json
{
  • "genre": "string",
  • "description": "string",
  • "demographic": true
}

Response samples

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

get genres

Authorizations:
bearerAuth
path Parameters
id
required
integer

Genre id

query Parameters
unrenderedFields
boolean

Output fields in unrendered form for editing

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "genre": "string",
  • "description": "string",
  • "stats": {
    },
  • "demographic": true
}

delete a genre

Authorizations:
bearerAuth
path Parameters
id
required
integer

id of genre

Responses

Response samples

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

update a genre

Authorizations:
bearerAuth
path Parameters
id
required
integer

id of genre

Request Body schema: application/json
required
genre
string (genre)
description
string (description)
demographic
boolean (demographic)

Responses

Request samples

Content type
application/json
{
  • "genre": "string",
  • "description": "string",
  • "demographic": true
}

Response samples

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

groups

groups

add an group

Authorizations:
bearerAuth
Request Body schema: application/json
required
name
string (name)
Array of objects (associated)
object (GroupsModelUpdateV1Social)
active
boolean (active)
notes
string (notes)
object (GroupsModelUpdateV1Admin)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "associated": [
    ],
  • "social": {
    },
  • "active": true,
  • "notes": "string",
  • "admin": {
    }
}

Response samples

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

get a specific group

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

Group id

query Parameters
unrenderedFields
boolean

Output fields in unrendered form for editing

Responses

Response samples

Content type
application/json
{
  • "group_id": 0,
  • "name": "string",
  • "url": "string",
  • "associated": [
    ],
  • "social": {
    },
  • "active": true,
  • "notes": "string",
  • "added_by": {
    },
  • "admin": {
    }
}

delete a group

Authorizations:
bearerAuth
path Parameters
id
required
integer

id of group

Responses

Response samples

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

update an group

Authorizations:
bearerAuth
path Parameters
id
required
integer

id of group

Request Body schema: application/json
required
name
string (name)
Array of objects (associated)
object (GroupsModelUpdateV1Social)
active
boolean (active)
notes
string (notes)
object (GroupsModelUpdateV1Admin)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "associated": [
    ],
  • "social": {
    },
  • "active": true,
  • "notes": "string",
  • "admin": {
    }
}

Response samples

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

reject and delete a group

Authorizations:
bearerAuth
path Parameters
id
required
integer

id of group

Responses

Response samples

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

search groups

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)
active
boolean (active)
pending
boolean (pending)

Responses

Request samples

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

Response samples

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

get the list of series and release frequency for a specific group

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

Group id

Responses

Response samples

Content type
application/json
{
  • "release_frequency": "string",
  • "series_titles": [
    ],
  • "series_genres": [
    ],
  • "series_categories": [
    ]
}

lists

lists

retrieve list of user lists

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

add a custom user list

Authorizations:
bearerAuth
Request Body schema: application/json
required
title
string (title)
description
string (description)
type
string (type)
Enum: "read" "wish" "complete" "unfinished" "hold"
icon
string (icon)
object (ListsModelUpdateV1Options)

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "description": "string",
  • "type": "read",
  • "icon": "string",
  • "options": {
    }
}

Response samples

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

retrieve list metadata and options

Authorizations:
bearerAuth
path Parameters
id
required
integer

List id

query Parameters
unrenderedFields
boolean

Output fields in unrendered form for editing

Responses

Response samples

Content type
application/json
{
  • "list_id": 0,
  • "title": "string",
  • "description": "string",
  • "type": "read",
  • "icon": "string",
  • "custom": true,
  • "options": {
    }
}

remove a custom list

Authorizations:
bearerAuth
path Parameters
id
required
integer

id of list

Responses

Response samples

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

update a user list

Authorizations:
bearerAuth
path Parameters
id
required
integer

id of list

Request Body schema: application/json
required
title
string (title)
description
string (description)
type
string (type)
Enum: "read" "wish" "complete" "unfinished" "hold"
icon
string (icon)
object (ListsModelUpdateV1Options)

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "description": "string",
  • "type": "read",
  • "icon": "string",
  • "options": {
    }
}

Response samples

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

retrieve list of user lists

Authorizations:
bearerAuth
path Parameters
user_id
required
integer

User id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

retrieve stats for user public lists

Authorizations:
bearerAuth
path Parameters
user_id
required
integer

User id

Responses

Response samples

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

search lists

Authorizations:
bearerAuth
path Parameters
user_id
required
integer

User id

id
required
integer

list id to search

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,
  • "list": {
    },
  • "results": [
    ]
}

search lists

Authorizations:
bearerAuth
path Parameters
id
required
integer

list id to search

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,
  • "list": {
    },
  • "results": [
    ]
}

add a series to a list

Authorizations:
bearerAuth
Request Body schema: application/json
required
Array
required
object (ListsSeriesModelUpdateV1Series)
list_id
integer (list_id)
object (ListsSeriesModelUpdateV1Status)
priority
integer (priority)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

add a list of series to a list

Authorizations:
bearerAuth
path Parameters
id
required
integer

id of list

Request Body schema: application/json
required
Array
priority
string (priority)
Enum: "High" "Low"
series_title
string (series_title)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

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

remove a series from a list

Authorizations:
bearerAuth
Request Body schema: application/json
required
Array
integer

Responses

Request samples

Content type
application/json
[
  • 0
]

Response samples

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

retrieve list series item

Authorizations:
bearerAuth
path Parameters
series_id
required
integer

Series id

query Parameters
unrenderedFields
boolean

Output fields in unrendered form for editing

Responses

Response samples

Content type
application/json
{
  • "series": {
    },
  • "list_id": 0,
  • "list_type": "string",
  • "list_icon": "string",
  • "status": {
    },
  • "priority": 0,
  • "time_added": {
    }
}

update a series list item

Authorizations:
bearerAuth
Request Body schema: application/json
required
Array
required
object (ListsSeriesModelUpdateV1Series)
list_id
integer (list_id)
object (ListsSeriesModelUpdateV1Status)
priority
integer (priority)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

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

retrieve users who have similar interests based on series

Authorizations:
bearerAuth
path Parameters
list_name
required
string
Enum: "read" "wish" "complete" "unfinished" "hold"

name of list

series_id
required
integer

Series id

Responses

Response samples

Content type
application/json
{
  • "total_hits": 0,
  • "users": [
    ]
}

misc

misc

get the current time

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "timestamp": 0,
  • "as_rfc3339": "2019-08-24T14:15:22Z",
  • "as_string": "string"
}

list online users

Authorizations:
bearerAuth

Responses

Response samples

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

get the status of a bulk transaction

Authorizations:
bearerAuth
path Parameters
transaction_id
required
string

the transaction id

Responses

Response samples

Content type
application/json
{
  • "state": "pending",
  • "error": "string",
  • "percent": 0,
  • "done": 0,
  • "total": 0,
  • "return": "string"
}

show various site stats

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "total_users": 0,
  • "latest_user": {
    },
  • "total_forum_topics": 0,
  • "total_forum_posts": 0
}

poll

poll

get the active poll

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "active": true,
  • "question": "string",
  • "answers": [
    ],
  • "total_votes": 0
}

add a new poll

Authorizations:
bearerAuth
Request Body schema: application/json
required
question
string (question)
Array of objects (answers)

Responses

Request samples

Content type
application/json
{
  • "question": "string",
  • "answers": [
    ]
}

Response samples

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

archive the active poll

Authorizations:
bearerAuth

Responses

Response samples

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

search archived polls

Authorizations:
bearerAuth
Request Body schema: application/json
required
search
string (search)
page
integer (page)
perpage
integer (perpage)
orderby
string (orderby)
Enum: "time_finished" "total_votes" "score"

Responses

Request samples

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

Response samples

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

vote in a poll

Authorizations:
bearerAuth

Responses

Response samples

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

vote in a poll answer

Authorizations:
bearerAuth
path Parameters
answer_id
required
integer

id of answer to vote for

Responses

Response samples

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

get information about whether the user has voted

Authorizations:
bearerAuth

Responses

Response samples

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

publishers

publishers

add an publisher

Authorizations:
bearerAuth
Request Body schema: application/json
required
name
string (name)
Array of objects (associated)
type
string (type)
Enum: "N/A" "Japanese" "English" "Korean" "Taiwanese" "Chinese" "Thai" "Indonesian" "Filipino" "Vietnamese" "Malaysian" "Nordic" "French" "Spanish" "Russian" "Polish" "Portuguese" "German" "Hindi" "Arabic"
info
string (info)
site
string (site)
object (PublishersModelUpdateV1Admin)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "associated": [
    ],
  • "type": "N/A",
  • "info": "string",
  • "site": "string",
  • "admin": {
    }
}

Response samples

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

get a specific publisher

Authorizations:
bearerAuth
path Parameters
id
required
integer

Publisher id

query Parameters
unrenderedFields
boolean

Output fields in unrendered form for editing

Responses

Response samples

Content type
application/json
{
  • "publisher_id": 0,
  • "name": "string",
  • "url": "string",
  • "associated": [
    ],
  • "type": "N/A",
  • "info": "string",
  • "site": "string",
  • "stats": {
    },
  • "added_by": {
    },
  • "last_updated": {
    },
  • "admin": {
    }
}

delete a publisher

Authorizations:
bearerAuth
path Parameters
id
required
integer

id of publisher

Responses

Response samples

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

update a publisher

Authorizations:
bearerAuth
path Parameters
id
required
integer

id of publisher

Request Body schema: application/json
required
name
string (name)
Array of objects (associated)
type
string (type)
Enum: "N/A" "Japanese" "English" "Korean" "Taiwanese" "Chinese" "Thai" "Indonesian" "Filipino" "Vietnamese" "Malaysian" "Nordic" "French" "Spanish" "Russian" "Polish" "Portuguese" "German" "Hindi" "Arabic"
info
string (info)
site
string (site)
object (PublishersModelUpdateV1Admin)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "associated": [
    ],
  • "type": "N/A",
  • "info": "string",
  • "site": "string",
  • "admin": {
    }
}

Response samples

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

search publishers

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)
orderby
string (orderby)
Enum: "score" "name" "series" "publications" "type"
pending
boolean (pending)

Responses

Request samples

Content type
application/json
{
  • "search": "string",
  • "added_by": 0,
  • "page": 0,
  • "perpage": 0,
  • "letter": "string",
  • "orderby": "score",
  • "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 publisher

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

Publisher id

Responses

Response samples

Content type
application/json
{
  • "series_list": [
    ],
  • "publication_list": [
    ]
}

get the list of series for a specific publication

Authorizations:
bearerAuth
query Parameters
pubname
required
string

Publication name

Responses

Response samples

Content type
application/json
{
  • "publisher": {
    },
  • "series_list": [
    ]
}

releases

releases

add an release

Authorizations:
bearerAuth
Request Body schema: application/json
required
Array
title
string (title)
volume
string (volume)
chapter
string (chapter)
Array of objects (groups)
release_date
string (release_date)
download_notes
string (download_notes)
comment
string (comment)
object (TimeUpdateV1)
object (ReleaseModelUpdateV1Admin)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

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

get a specific release

Authorizations:
bearerAuth
path Parameters
id
required
integer

Release id

query Parameters
unrenderedFields
boolean

Output fields in unrendered form for editing

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "title": "string",
  • "volume": "string",
  • "chapter": "string",
  • "groups": [
    ],
  • "release_date": "string",
  • "download_notes": "string",
  • "comment": "string",
  • "time_added": {
    },
  • "admin": {
    }
}

delete a release

Authorizations:
bearerAuth
path Parameters
id
required
integer

id of release

Responses

Response samples

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

update an release

Authorizations:
bearerAuth
path Parameters
id
required
integer

id of release

Request Body schema: application/json
required
title
string (title)
volume
string (volume)
chapter
string (chapter)
Array of objects (groups)
release_date
string (release_date)
download_notes
string (download_notes)
comment
string (comment)
object (TimeUpdateV1)
object (ReleaseModelUpdateV1Admin)

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "volume": "string",
  • "chapter": "string",
  • "groups": [
    ],
  • "release_date": "string",
  • "download_notes": "string",
  • "comment": "string",
  • "time_added": {
    },
  • "admin": {
    }
}

Response samples

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

search releases to moderate

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

Responses

Request samples

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

Response samples

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

show releases by day

Authorizations:
bearerAuth
query Parameters
page
integer <int64>

Start page

include_metadata
boolean
Default: false

Include series metadata (if available)

Responses

Response samples

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

releases rss feed

Authorizations:
bearerAuth

Responses

search releases

Authorizations:
bearerAuth
Request Body schema: application/json
required
search
string (search)
search_type
string (search_type)
Enum: "series" "regular"
added_by
integer (added_by)
page
integer (page)
perpage
integer (perpage)
letter
string (letter)
orderby
string (orderby)
Enum: "date" "time" "title" "vol" "chap"
start_date
string (start_date)
end_date
string (end_date)
asc
string (asc)
Enum: "asc" "desc"
group_id
integer (group_id)
pending
boolean (pending)
include_metadata
boolean (include_metadata)

Responses

Request samples

Content type
application/json
{
  • "search": "string",
  • "search_type": "series",
  • "added_by": 0,
  • "page": 0,
  • "perpage": 0,
  • "letter": "string",
  • "orderby": "date",
  • "start_date": "string",
  • "end_date": "string",
  • "asc": "asc",
  • "group_id": 0,
  • "pending": true,
  • "include_metadata": true
}

Response samples

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

reviews

reviews

add a review

Authorizations:
bearerAuth
Request Body schema: application/json
required
title
string (title)
body
string (body)
series_title
string (series_title)
object (ReviewModelUpdateV1Review)
object (ReviewModelUpdateV1Admin)

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "body": "string",
  • "series_title": "string",
  • "review": {
    },
  • "admin": {
    }
}

Response samples

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

add a review comment

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

Review id

Request Body schema: application/json
required
subject
string (subject)
content
string (content)
rating
number (rating)
object (ReviewCommentModelUpdateV1Admin)

Responses

Request samples

Content type
application/json
{
  • "subject": "string",
  • "content": "string",
  • "rating": 0,
  • "admin": {
    }
}

Response samples

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

get a specific review comment

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

Review id

comment_id
required
integer <int64>

Review comment id

query Parameters
unrenderedFields
boolean

Output fields in unrendered form for editing

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "review_id": 0,
  • "subject": "string",
  • "content": "string",
  • "author": {
    },
  • "rating": 0,
  • "time_added": {
    },
  • "time_updated": {
    }
}

delete a review comment

Authorizations:
bearerAuth
path Parameters
id
required
integer

id of review

comment_id
required
integer

id of review comment

Responses

Response samples

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

update a review comment

Authorizations:
bearerAuth
path Parameters
id
required
integer

id of review

comment_id
required
integer

id of review comment

Request Body schema: application/json
required
subject
string (subject)
content
string (content)
rating
number (rating)
object (ReviewCommentModelUpdateV1Admin)

Responses

Request samples

Content type
application/json
{
  • "subject": "string",
  • "content": "string",
  • "rating": 0,
  • "admin": {
    }
}

Response samples

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

moderate review comments

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

Responses

Request samples

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

Response samples

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

search review comments

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

Review id

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

Responses

Request samples

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

Response samples

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

get a specific review

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

Review id

query Parameters
unrenderedFields
boolean

Output fields in unrendered form for editing

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "title": "string",
  • "body": "string",
  • "author": {
    },
  • "series": {
    },
  • "review": {
    },
  • "time_added": {
    }
}

delete a review

Authorizations:
bearerAuth
path Parameters
id
required
integer

id of review

Responses

Response samples

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

update a review

Authorizations:
bearerAuth
path Parameters
id
required
integer

id of review

Request Body schema: application/json
required
title
string (title)
body
string (body)
series_title
string (series_title)
object (ReviewModelUpdateV1Review)
object (ReviewModelUpdateV1Admin)

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "body": "string",
  • "series_title": "string",
  • "review": {
    },
  • "admin": {
    }
}

Response samples

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

search reviews

Authorizations:
bearerAuth
Request Body schema: application/json
required
search
string (search)
added_by
integer (added_by)
series_id
integer (series_id)
page
integer (page)
perpage
integer (perpage)
letter
string (letter)
pending
boolean (pending)

Responses

Request samples

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

Response samples

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

series

series

add an series

Authorizations:
bearerAuth
Request Body schema: application/json
required
title
string (title)
Array of objects (associated)
description
string (description)
type
string (type)
Enum: "Artbook" "Doujinshi" "Drama CD" "Filipino" "Indonesian" "Manga" "Manhwa" "Manhua" "Novel" "OEL" "Thai" "Vietnamese" "Malaysian" "Nordic" "French" "Spanish" "German"
year
string (year)
Array of objects (genres)
Array of objects (categories)
status
string (status)
licensed
boolean (licensed)
completed
boolean (completed)
object (SeriesModelUpdateV1Anime)
Array of objects (related_series)
Array of objects (authors)
Array of objects (publishers)
Array of objects (publications)
object (SeriesModelUpdateV1Admin)

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "associated": [
    ],
  • "description": "string",
  • "type": "Artbook",
  • "year": "string",
  • "genres": [
    ],
  • "categories": [
    ],
  • "status": "string",
  • "licensed": true,
  • "completed": true,
  • "anime": {
    },
  • "related_series": [
    ],
  • "authors": [
    ],
  • "publishers": [
    ],
  • "publications": [
    ],
  • "admin": {
    }
}

Response samples

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

combine two series categories

Authorizations:
bearerAuth
path Parameters
id
required
integer

id of series

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

Responses

Request samples

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

Response samples

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

deletes a series category

Authorizations:
bearerAuth
path Parameters
id
required
integer

id of series

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

Responses

Request samples

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

Response samples

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

renames a series category

Authorizations:
bearerAuth
path Parameters
id
required
integer

id of series

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

Responses

Request samples

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

Response samples

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

get category votes for the current user

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

Series id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

add a vote for a category on a series

Authorizations:
bearerAuth
path Parameters
id
required
integer

id of series

Request Body schema: application/json
required
category
required
string (category)
agree
boolean (agree)

Responses

Request samples

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

Response samples

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

remove series category vote for user

Authorizations:
bearerAuth
path Parameters
id
required
integer

id of series

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

Responses

Request samples

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

Response samples

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

add a series comment

Authorizations:
bearerAuth
path Parameters
id
required
integer

id of series

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

Responses

Request samples

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

Response samples

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

get a specific series comment

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

Series id

comment_id
required
integer <int64>

Series comment id

query Parameters
unrenderedFields
boolean

Output fields in unrendered form for editing

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "series_id": 0,
  • "subject": "string",
  • "content": "string",
  • "author": {
    },
  • "useful": 0,
  • "time_added": {
    },
  • "time_updated": {
    },
  • "admin": {
    }
}

delete a series comment

Authorizations:
bearerAuth
path Parameters
id
required
integer

id of series

comment_id
required
integer

id of series comment

Responses

Response samples

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

update a series comment

Authorizations:
bearerAuth
path Parameters
id
required
integer

id of series

comment_id
required
integer

id of series comment

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

Responses

Request samples

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

Response samples

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

moderate series comments

Authorizations:
bearerAuth
Request Body schema: application/json
required
method
string (method)
Enum: "useful" "time_added"
added_by
integer (added_by)
page
integer (page)
perpage
integer (perpage)

Responses

Request samples

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

Response samples

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

report a series comment

Authorizations:
bearerAuth
path Parameters
id
required
integer

id of series

comment_id
required
integer

id of series comment

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

Responses

Request samples

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

Response samples

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

get my series comment

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

Series id

query Parameters
unrenderedFields
boolean

Output fields in unrendered form for editing

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "series_id": 0,
  • "subject": "string",
  • "content": "string",
  • "author": {
    },
  • "useful": 0,
  • "time_added": {
    },
  • "time_updated": {
    },
  • "admin": {
    }
}

get a specific series comment location

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

Series id

comment_id
required
integer <int64>

Series comment id

Responses

Response samples

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

search series comments

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

Series id

Request Body schema: application/json
required
method
string (method)
Enum: "useful" "time_added"
added_by
integer (added_by)
page
integer (page)
perpage
integer (perpage)

Responses

Request samples

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

Response samples

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

set usefulness of a series comment

Authorizations:
bearerAuth
path Parameters
id
required
integer

id of series

comment_id
required
integer

id of series comment

Request Body schema: application/json
required
useful
boolean (useful)

Responses

Request samples

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

Response samples

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

remove usefulness of a series comment

Authorizations:
bearerAuth
path Parameters
id
required
integer

id of series

comment_id
required
integer

id of series comment

Responses

Response samples

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

get a specific series

Authorizations:
bearerAuth
path Parameters
id
required
integer

Series id

query Parameters
unrenderedFields
boolean

Output fields in unrendered form for editing

Responses

Response samples

Content type
application/json
{
  • "series_id": 0,
  • "title": "string",
  • "url": "string",
  • "associated": [
    ],
  • "description": "string",
  • "image": {
    },
  • "type": "Artbook",
  • "year": "string",
  • "bayesian_rating": 0,
  • "rating_votes": 0,
  • "genres": [
    ],
  • "categories": [
    ],
  • "latest_chapter": 0,
  • "forum_id": 0,
  • "status": "string",
  • "licensed": true,
  • "completed": true,
  • "anime": {
    },
  • "related_series": [
    ],
  • "authors": [
    ],
  • "publishers": [
    ],
  • "publications": [
    ],
  • "recommendations": [
    ],
  • "category_recommendations": [
    ],
  • "rank": {
    },
  • "last_updated": {
    },
  • "admin": {
    }
}

delete a series

Authorizations:
bearerAuth
path Parameters
id
required
integer

id of series

Responses

Response samples

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

update an series

Authorizations:
bearerAuth
path Parameters
id
required
integer

id of series

Request Body schema: application/json
required
title
string (title)
Array of objects (associated)
description
string (description)
type
string (type)
Enum: "Artbook" "Doujinshi" "Drama CD" "Filipino" "Indonesian" "Manga" "Manhwa" "Manhua" "Novel" "OEL" "Thai" "Vietnamese" "Malaysian" "Nordic" "French" "Spanish" "German"
year
string (year)
Array of objects (genres)
Array of objects (categories)
status
string (status)
licensed
boolean (licensed)
completed
boolean (completed)
object (SeriesModelUpdateV1Anime)
Array of objects (related_series)
Array of objects (authors)
Array of objects (publishers)
Array of objects (publications)
object (SeriesModelUpdateV1Admin)

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "associated": [
    ],
  • "description": "string",
  • "type": "Artbook",
  • "year": "string",
  • "genres": [
    ],
  • "categories": [
    ],
  • "status": "string",
  • "licensed": true,
  • "completed": true,
  • "anime": {
    },
  • "related_series": [
    ],
  • "authors": [
    ],
  • "publishers": [
    ],
  • "publications": [
    ],
  • "admin": {
    }
}

Response samples

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

get the list of groups scanlating a specific series

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

Series id

Responses

Response samples

Content type
application/json
{
  • "group_list": [
    ],
  • "release_list": [
    ]
}

search series history

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

Series 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,
  • "series_title": "string",
  • "results": [
    ]
}

get a specific series lock

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

Series id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

lock a field of an series

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

id of series

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 series

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

id of series

item
required
string

field name

Responses

Response samples

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

get a specific series rank location

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

Series id

type
required
string

Stat type

Responses

Response samples

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

get a specific series rating for a user

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

Series id

Responses

Response samples

Content type
application/json
{
  • "rating": 0,
  • "last_updated": {
    }
}

update the user rating for a series

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

id of series

Request Body schema: application/json
required
rating
required
number (rating)
object (TimeV1)

Responses

Request samples

Content type
application/json
{
  • "rating": 0,
  • "last_updated": {
    }
}

Response samples

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

delete a series rating for a user

Authorizations:
bearerAuth
path Parameters
id
required
integer

id of series

Responses

Response samples

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

get a the series rating rainbow

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

Series id

Responses

Response samples

Content type
application/json
{
  • "average_rating": 0,
  • "rainbow": [
    ]
}

releases rss feed for a specific series

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

id of series

Responses

search series

Authorizations:
bearerAuth
Request Body schema: application/json
required
search
string (search)
added_by
integer (added_by)
stype
string (stype)
Enum: "title" "description"
licensed
string (licensed)
Enum: "yes" "no"
type
Array of strings (type)
year
string (year)
filter_types
Array of strings (filter_types)
category
Array of strings (category)
pubname
string (pubname)
filter
string (filter)
Enum: "scanlated" "completed" "oneshots" "no_oneshots" "some_releases" "no_releases"
filters
Array of strings (filters)
Items Enum: "scanlated" "completed" "oneshots" "no_oneshots" "some_releases" "no_releases"

Meant to replace 'filter', it lets you specify multiple filters as an array of strings

list
string (list)
page
integer (page)
perpage
integer (perpage)
letter
string (letter)
genre
Array of strings (genre)
exclude_genre
Array of strings (exclude_genre)
orderby
string (orderby)
Enum: "score" "title" "rank" "rating" "year" "date_added" "week_pos" "month1_pos" "month3_pos" "month6_pos" "year_pos" "list_reading" "list_wish" "list_complete" "list_unfinished"
pending
boolean (pending)
include_rank_metadata
boolean (include_rank_metadata)
exclude_filtered_genres
boolean (exclude_filtered_genres)

Responses

Request samples

Content type
application/json
{
  • "search": "string",
  • "added_by": 0,
  • "stype": "title",
  • "licensed": "yes",
  • "type": [
    ],
  • "year": "string",
  • "filter_types": [
    ],
  • "category": [
    ],
  • "pubname": "string",
  • "filter": "scanlated",
  • "filters": [
    ],
  • "list": "string",
  • "page": 0,
  • "perpage": 0,
  • "letter": "string",
  • "genre": [
    ],
  • "exclude_genre": [
    ],
  • "orderby": "score",
  • "pending": true,
  • "include_rank_metadata": true,
  • "exclude_filtered_genres": true
}

Response samples

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

update the image of an series

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

id of series

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 series

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

id of series

Responses

Response samples

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

members

members

get user group

Authorizations:
bearerAuth
path Parameters
id
required
string

user group id

query Parameters
unrenderedFields
boolean

Output fields in unrendered form for editing

Responses

Response samples

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

add or update a user group

Authorizations:
bearerAuth
path Parameters
id
required
string

user group id

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

Responses

Request samples

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

Response samples

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

delete a user group

Authorizations:
bearerAuth
path Parameters
id
required
string

id of user group

Responses

Response samples

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

get user groups

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

add a member

Authorizations:
bearerAuth
Request Body schema: application/json
required
username
string (username)
email
string (email)
password
string <password> (password)
new_avatar_id
integer (new_avatar_id)
gender
string (gender)
Enum: "N/A" "Male" "Female" "Alien" "Hermaphrodite" "Non-binary" "Other"
object (BirthdayModelV1)
timezone
integer (timezone)
signature
string (signature)
location
string (location)
forum_title
string (forum_title)
folding_at_home
boolean (folding_at_home)
object (UserModelUpdateV1Profile)
object (UserModelUpdateV1Admin)
user_group
string (user_group)

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "email": "string",
  • "password": "pa$$word",
  • "new_avatar_id": 0,
  • "gender": "N/A",
  • "birthday": {
    },
  • "timezone": 0,
  • "signature": "string",
  • "location": "string",
  • "forum_title": "string",
  • "folding_at_home": true,
  • "profile": {
    },
  • "admin": {
    },
  • "user_group": "string"
}

Response samples

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

search change requests for a specific user

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

Member id

query Parameters
page
integer

Start page

perpage
integer

Items per page

orderby
string
Default: "time"
Enum: "score" "time"

order by field

asc
string
Default: "asc"
Enum: "asc" "desc"

Direction of results

Responses

Response samples

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

add a change request

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

Member id

Request Body schema: application/json
required
body
string (body)
archived
boolean (archived)

Responses

Request samples

Content type
application/json
{
  • "body": "string",
  • "archived": true
}

Response samples

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

get change requests for a specific user

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

Member id

request_id
required
integer <int64>

Change request id

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "body": "string",
  • "added_by": {
    },
  • "time_added": {
    }
}

add a change request

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

Member id

request_id
required
integer <int64>

Change request id

Responses

Response samples

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

update a change request

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

Member id

request_id
required
integer <int64>

Change request id

Request Body schema: application/json
required
body
string (body)
archived
boolean (archived)

Responses

Request samples

Content type
application/json
{
  • "body": "string",
  • "archived": true
}

Response samples

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

get a specific members

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

Member id

query Parameters
unrenderedFields
boolean

Output fields in unrendered form for editing

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"
}

delete a member

Authorizations:
bearerAuth
path Parameters
id
required
integer

Member id

Responses

Response samples

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

update a member

Authorizations:
bearerAuth
path Parameters
id
required
integer

Member id

Request Body schema: application/json
required
username
string (username)
email
string (email)
password
string <password> (password)
new_avatar_id
integer (new_avatar_id)
gender
string (gender)
Enum: "N/A" "Male" "Female" "Alien" "Hermaphrodite" "Non-binary" "Other"
object (BirthdayModelV1)
timezone
integer (timezone)
signature
string (signature)
location
string (location)
forum_title
string (forum_title)
folding_at_home
boolean (folding_at_home)
object (UserModelUpdateV1Profile)
object (UserModelUpdateV1Admin)
user_group
string (user_group)

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "email": "string",
  • "password": "pa$$word",
  • "new_avatar_id": 0,
  • "gender": "N/A",
  • "birthday": {
    },
  • "timezone": 0,
  • "signature": "string",
  • "location": "string",
  • "forum_title": "string",
  • "folding_at_home": true,
  • "profile": {
    },
  • "admin": {
    },
  • "user_group": "string"
}

Response samples

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

get genre filters for a specific user

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

Member id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

filter a genre for a user

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

id of member

genre_id
required
integer

genre id

Responses

Response samples

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

remove a filter for a genre for a user

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

id of member

genre_id
required
integer

genre id

Responses

Response samples

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

get highlights for a specific user

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

Member id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

highlight a genre for a user

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

id of member

genre_id
required
integer

genre id

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

Responses

Request samples

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

Response samples

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

remove a highlight for a genre for a user

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

id of member

genre_id
required
integer

genre id

Responses

Response samples

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

reset genre highlights and filters for a user

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

id of member

Responses

Response samples

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

get group filters for a specific user

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

Member id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

filter a group for a user

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

id of member

group_id
required
integer

group id

Responses

Response samples

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

remove a filter for a group for a user

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

id of member

group_id
required
integer

group id

Responses

Response samples

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

get avatars for a specific user

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

Member id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

search members

Authorizations:
bearerAuth
Request Body schema: application/json
required
search
string (search)
page
integer (page)
perpage
integer (perpage)
letter
string (letter)
orderby
string (orderby)
Enum: "username" "time_added" "forum_posts" "added_authors" "added_releases" "added_groups" "added_publishers" "added_series" "is_admin"
asc
string (asc)
Enum: "asc" "desc"

Responses

Request samples

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

Response samples

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

get a specific member sessions if they exists

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

Member id

Responses

Response samples

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

delete all a members sessions

Authorizations:
bearerAuth
path Parameters
id
required
integer

Member id

Responses

Response samples

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

get topic subscriptions for a specific user

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

Member id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

get a subscription to a specific topic for a user

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

Member id

topic_id
required
integer <int64>

Topic id

Responses

Response samples

Content type
application/json
{
  • "topic_id": 0,
  • "topic": {
    },
  • "time_subscribed_since": {
    }
}

add a topic subscription for a user

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

id of member

topic_id
required
integer

topic id

Responses

Response samples

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

remove a topic subscription for a user

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

id of member

topic_id
required
integer

topic id

Responses

Response samples

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

add a new member avatar

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

Member id

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

Image to update

title
string

Title of the new avatar

Responses

Response samples

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

delete a member avatar

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

Member id

avatar_id
required
integer <int64>

Avatar id

Responses

Response samples

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

upgrade a member

Authorizations:
bearerAuth
path Parameters
id
required
integer

Member id

Responses

Response samples

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

reject a member upgrade

Authorizations:
bearerAuth
path Parameters
id
required
integer

Member id

Responses

Response samples

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