Get List Info

Returns info about a list

Responses

🟢200Success

application/json

Body

Represents a UserList

internal_id

number

optional

name

string

optional

description

string | null

optional

owner

object

optional

string

optional

username

string | null

optional

neopetsUser

string | null

optional

lastSeen

string

optional

Date string in the ISO 8601 format. Always point out to start of the day for privacy reasons

coverURL

string | null

optional

official

boolean

optional

purpose

enum<string>

optional

Whether the list is a wishlist, tradelist, or neither

Allowed values:

seekingtradingnone

Default:

none

visibility

enum<string>

optional

Unlisted and private lists will not appear in the API (except if it is an official list)

Allowed values:

publicprivateunlisted

Default:

public

colorHex

string

optional

List's color theme

Example:

#fff000

sortBy

string

optional

Default:

name

sortDir

enum<string>

optional

Allowed values:

ascdesc

Default:

asc

order

number

optional

List order at user's profile

createdAt

string

optional

Date string in the ISO 8601 format

updatedAt

string

optional

Date string in the ISO 8601 format

itemCount

number

optional

How many items are on this list

itemInfo

array[object (ListItemInfo) {10}]

optional

internal_id

number

optional

This instance internal_id

list_id

number

optional

List's internal_id

item_iid

number

optional

Item's internal_id

addedAt

string

optional

Date string in the ISO 8601 format

updatedAt

string

optional

Date string in the ISO 8601 format

amount

number

optional

capValue

number | null

optional

User-defined cap value for

imported

string

optional

order

number | null

optional

isHighlight

boolean

optional

user_id

string

deprecated

user_username

string | null

deprecated

user_neouser

string

deprecated

Example

[
    {
        "internal_id": 26,
        "name": "Tarla Main Prizes",
        "description": "Main items given by Tarla Non-Toolbar Treasures",
        "coverURL": "https://images.neopets.com/games/tradingcards/369.gif",
        "colorHex": "#c63956",
        "purpose": "none",
        "official": true,
        "visibility": "public",
        "user_id": "Ty0G4IOIm4dr3IYJpMx8bIFMs433",
        "user_username": "temp_user",
        "user_neouser": "temp_username",
        "owner": {
            "id": "Ty0G4IOIm4dr3IYJpMx8bIFMs433",
            "username": "temp_user",
            "neopetsUser": "temp_username",
            "lastSeen": "2023-04-01T22:00:00.000Z"
        },
        "createdAt": "2023-04-02T18:57:27.227Z",
        "updatedAt": "2023-04-02T21:01:14.834Z",
        "sortBy": "price",
        "sortDir": "desc",
        "order": 2,
        "itemCount": 2,
        "itemInfo": [
            {
                "internal_id": 1507,
                "list_id": 26,
                "item_iid": 25,
                "addedAt": "2023-04-02T19:06:05.851Z",
                "updatedAt": "2023-04-02T19:06:05.851Z",
                "amount": 1,
                "capValue": null,
                "imported": false,
                "order": null,
                "isHighlight": false
            },
            {
                "internal_id": 1429,
                "list_id": 26,
                "item_iid": 103,
                "addedAt": "2023-04-02T18:57:57.819Z",
                "updatedAt": "2023-04-02T18:57:57.819Z",
                "amount": 1,
                "capValue": null,
                "imported": false,
                "order": null,
                "isHighlight": false
            }
        ]
    }
]

Request

Responses