List a library's series

GET

/api/v1/libraries/{libraryId}/series

curl --request GET \
  --url 'http://localhost:8080/api/v1/libraries/1/series?limit=50' \
  --header 'Authorization: Bearer <token>'

Series in title order, with numbers inside titles compared by value.

Authorizations

• session
• basic

Parameters

Path Parameters

libraryId

required

integer format: int64

Query Parameters

cursor

string

Opaque cursor from the previous page’s nextCursor.

limit

integer

default: 50 >= 1 <= 200

Items per page. Values outside the range are clamped.

Responses

200

One page of series.

Media typeapplication/json

object

items

required

Array<object>

object

editedFields

required

Fields an admin changed by hand, which rescans keep.

Array<string>

Allowed values: title

id

required

integer format: int64

libraryId

required

integer format: int64

title

required

string

publicationCount

required

integer format: int64

coverPublicationId

The first publication in the series that has a cover; fetch its cover to show the series.

integer | null format: int64

nextCursor

Pass as cursor to get the next page. Absent on the last page.

string

Example

{
  "items": [
    {
      "editedFields": [
        "title"
      ]
    }
  ]
}

400

The request was malformed.

Media typeapplication/json

object

code

required

string

Allowed values: bad_request unauthorized forbidden not_found unavailable scan_in_progress content_changed already_set_up name_taken last_admin progress_conflict too_many_attempts not_linked identity_taken last_sign_in provider_unavailable too_many_sign_ins repository_exists repository_not_allowed repository_unreadable repository_needs_token repository_needs_password repository_needs_credentials repository_credentials_refused extension_invalid source_failed source_unavailable source_check_failed internal

message

required

Explains the problem to a developer.

string

Example

{
  "code": "bad_request"
}

401

The request has no valid session token.

Media typeapplication/json

object

code

required

string

Allowed values: bad_request unauthorized forbidden not_found unavailable scan_in_progress content_changed already_set_up name_taken last_admin progress_conflict too_many_attempts not_linked identity_taken last_sign_in provider_unavailable too_many_sign_ins repository_exists repository_not_allowed repository_unreadable repository_needs_token repository_needs_password repository_needs_credentials repository_credentials_refused extension_invalid source_failed source_unavailable source_check_failed internal

message

required

Explains the problem to a developer.

string

Example

{
  "code": "bad_request"
}

404

The resource does not exist.

Media typeapplication/json

object

code

required

string

Allowed values: bad_request unauthorized forbidden not_found unavailable scan_in_progress content_changed already_set_up name_taken last_admin progress_conflict too_many_attempts not_linked identity_taken last_sign_in provider_unavailable too_many_sign_ins repository_exists repository_not_allowed repository_unreadable repository_needs_token repository_needs_password repository_needs_credentials repository_credentials_refused extension_invalid source_failed source_unavailable source_check_failed internal

message

required

Explains the problem to a developer.

string

Example

{
  "code": "bad_request"
}

500

The server failed; details are in its log.

Media typeapplication/json

object

code

required

string

Allowed values: bad_request unauthorized forbidden not_found unavailable scan_in_progress content_changed already_set_up name_taken last_admin progress_conflict too_many_attempts not_linked identity_taken last_sign_in provider_unavailable too_many_sign_ins repository_exists repository_not_allowed repository_unreadable repository_needs_token repository_needs_password repository_needs_credentials repository_credentials_refused extension_invalid source_failed source_unavailable source_check_failed internal

message

required

Explains the problem to a developer.

string

Example

{
  "code": "bad_request"
}