Retrieve a list

Pending

GET

/v1/residents/{id}/lists/{listId}

listsresidents

Last modified:2026-03-29 18:28:25

Maintainer:Not configured

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'http://localhost:4002/rest/v1/residents//lists/' \
--header 'X-Nexus-Key: ' \
--header 'Authorization: Bearer <token>'

Responses

🟢200Success

application/json

Body

Example

{
    "id": "lst_A1qk1czuEupGQIy6",
    "slug": "my-xbox-exclusive-favorites",
    "name": "My Xbox Exclusive Favorites",
    "description": null,
    "is_public": true,
    "total_items": 0,
    "created_at": "2025-05-05T19:13:15.674Z",
    "updated_at": "2025-05-05T19:13:15.674Z",
    "items": [
        {
            "id": "li_KbDMoEmP74jhLl3E",
            "list_id": "lst_A1qk1czuEupGQIy6",
            "game_id": "4079",
            "game_title": "Halo",
            "game_slug": "halo",
            "game_cover": "//images.igdb.com/igdb/image/upload/t_thumb/co99dv.jpg",
            "added_at": "2026-03-26T00:03:21.695Z"
        }
    ]
}

🟠400Bad Request

🟠401Unathorized

🟠404Not Found

🔴500Server Error

Modified at 2026-03-29 18:28:25

List all lists

Create a list