Get your lists

​

Returns your lists — decks, want lists, and for-sale lists — each with its name, status, and a summary of how many cards it holds and how complete it is.

The cards themselves are not included here. Fetch a single list with GET /v1/lists/{listId} to get its cards.

Filter by game, status, visibility, or name. Results are paginated with offset and limit.

Requires the lists:read scope.

Query Parameters
  • offset
    Type: integer
    min:  
    0
    max:  
    9007199254740991

    Integer numbers.

  • limit
    Type: integer
    min:  
    1
    max:  
    200

    Integer numbers.

  • game
    Type: string
    min length:  
    1

    Return only lists for this game, given as a slug, e.g. pokemon.

  • status
    Type: string enum

    Return only lists with this status: forSale, toComplete, or hold.

    values
    • forSale

      Cards you're offering for sale.

    • toComplete

      Cards you're working to complete, such as a want list or a deck in progress.

    • hold

      Cards you're keeping aside.

  • isPublic
    Type: boolean

    true returns only public lists; false returns only private ones. Omit to return both.

  • name
    Type: string
    min length:  
    1

    Return only lists whose name contains this value, case-insensitively.

Responses
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for get/lists
curl https://public-api.cardnexus.com/v1/lists \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "data": [
    {
      "id": "6512a0b4e1d2c3f4a5b6c7d8",
      "name": "Modern deck — missing pieces",
      "game": "mtg",
      "status": "toComplete",
      "description": null,
      "bannerUrl": "https://ik.imagekit.io/cardnexus/production/mtg/mh2-137-front.png",
      "completionPercentage": 64,
      "itemCount": 11,
      "totalQuantity": 23
    },
    {
      "id": "6512a0b4e1d2c3f4a5b6c7d9",
      "name": "Trade binder",
      "game": "pokemon",
      "status": "forSale",
      "description": "Spares I'm happy to move on.",
      "bannerUrl": null,
      "completionPercentage": 100,
      "itemCount": 42,
      "totalQuantity": 118
    }
  ],
  "pagination": {
    "offset": 0,
    "limit": 50,
    "total": 2,
    "hasMore": false
  }
}

Your lists.