Create a list

POST

/v1/lists

lists

Last modified:2026-05-25 03:42:28

Maintainer:JoseMa Esparza

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Header Params

Body Params application/json

Example

{
    "name": "My Xbox Exclusive Favorites",
    "is_public": true
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'http://localhost:4002/rest/v1/lists' \
--header 'X-Nexus-Key: ' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "name": "My Xbox Exclusive Favorites",
    "is_public": true
}'

Responses

🟢201Created

application/json

Bodyapplication/json

Example

{
    "id": "lst_A1qk1czuEupGQIy6",
    "slug": "my-xbox-exclusive-favorites",
    "name": "My Xbox Exclusive Favorites",
    "description": null,
    "is_public": true,
    "total_items": 0,
    "resident_id": "res_z2mBqk28BgdRCi4W",
    "created_at": "2025-05-05T19:13:15.674Z",
    "updated_at": "2025-05-05T19:13:15.674Z"
}

🟠400Bad Request

🟠401Unathorized

🟠404Not Found

🔴500Server Error

Modified at 2026-05-25 03:42:28

Retrieve a list

Add game to list