Skip to main content
POST
/
api
/
v1
/
readlists
Create readlist
curl --request POST \
  --url https://demo.komga.org/api/v1/readlists \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "bookIds": [
    "<string>"
  ],
  "name": "<string>",
  "ordered": true,
  "summary": "<string>"
}
'
{
  "bookIds": [
    "<string>"
  ],
  "createdDate": "2023-11-07T05:31:56Z",
  "filtered": true,
  "id": "<string>",
  "lastModifiedDate": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "ordered": true,
  "summary": "<string>"
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
​
bookIds
string[]
required
Minimum array length: 1
​
name
string
required
Minimum string length: 1
​
ordered
boolean
required
​
summary
string
required

Response

OK

​
bookIds
string[]
required
​
createdDate
string<date-time>
required
​
filtered
boolean
required
​
id
string
required
​
lastModifiedDate
string<date-time>
required
​
name
string
required
​
ordered
boolean
required
​
summary
string
required