List game library statuses as virtual lists

GET

/residents/{id}/library/lists

library

Last modified:2026-05-28 02:57:01

Maintainer:Not configured

Returns all predefined game library statuses as list-shaped objects suitable
for profile or dashboard previews.

When include_first_4_items=true, each list includes up to four recently
added games ordered by added_at descending.

Unlike custom lists, this endpoint always succeeds for valid residents and
returns all status buckets (with total_items: 0 when empty). For visitors,
private status buckets are omitted entirely.

Request

Authorization

Path Params

Query Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'http://localhost:4002/rest/residents//library/lists?include_first_4_items=true' \
--header 'X-Nexus-Key: '

Responses

🟢200

application/json

Game library status lists

Bodyapplication/json

Examples

With preview itemsWithout preview items

[
    {
        "id": "WISHLIST",
        "slug": "wishlist",
        "name": "Wishlist",
        "description": null,
        "is_public": true,
        "total_items": 12,
        "status": "WISHLIST",
        "items": [
            {
                "id": "1942",
                "name": "The Witcher 3",
                "cover": "https://images.igdb.com/igdb/image/upload/t_cover_big/co1wyy.jpg"
            }
        ]
    },
    {
        "id": "PLAYING",
        "slug": "playing",
        "name": "Playing",
        "description": null,
        "is_public": true,
        "total_items": 2,
        "status": "PLAYING",
        "items": [
            {
                "id": "119171",
                "name": "Hades II",
                "cover": "https://images.igdb.com/igdb/image/upload/t_cover_big/co6pib.jpg"
            }
        ]
    }
]

🟠422UnprocessableEntity

Modified at 2026-05-28 02:57:01

Get library visibility settings

Update library visibility settings