Create a list

Tested

POST

/v1/residents/{id}/lists

listsresidents

Last modified:2025-10-27 02:04:21

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

Body Params application/json

Example

{
    "name": "string",
    "description": "string",
    "is_public": true
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://localhost:4002/rest/v1/residents/res_z2mBqk28BgdRCi4W/lists' \
--header 'X-Nexus-Key: ' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "string",
    "description": "string",
    "is_public": true
}'

Responses

🟢201Created

application/json

Body

Example

{
    "id": "lst_Xsx74nAI7x8L9ZvB",
    "slug": "my-favorite-xbox-games",
    "name": "My favorite Xbox Games",
    "description": null,
    "is_public": false,
    "total_items": 0,
    "resident_id": "res_PoCDmWaP9uxxkStu",
    "created_at": "2025-05-05T19:30:37.163Z",
    "updated_at": "2025-05-05T19:30:37.163Z"
}

🟠400Bad Request

🟠401Unathorized

🟠404Not Found

🔴500Server Error

Modified at 2025-10-27 02:04:21

Retrieve a list

Add game to list