---
agentTools:
  projectIndex: https://imx.readme.io/llms.txt
---

# Get a list of packs

Returns a list of packs

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Gods Unchained API",
    "version": "1.0",
    "description": "Gods Unchained API",
    "contact": {
      "name": "Immutable",
      "url": "https://godsunchained.com"
    },
    "termsOfService": "https://github.com/immutable/gods-unchained-api"
  },
  "servers": [
    {
      "url": "https://api.godsunchained.com"
    }
  ],
  "paths": {
    "/v0/pack": {
      "get": {
        "summary": "Get a list of packs",
        "tags": [
          "pack"
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/PackList"
                }
              }
            }
          }
        },
        "operationId": "listPacks",
        "description": "Returns a list of packs",
        "parameters": [
          {
            "$ref": "#/components/parameters/page"
          },
          {
            "$ref": "#/components/parameters/perPage"
          },
          {
            "$ref": "#/components/parameters/sort"
          },
          {
            "$ref": "#/components/parameters/order"
          },
          {
            "$ref": "#/components/parameters/type"
          },
          {
            "schema": {
              "type": "string"
            },
            "in": "query",
            "name": "user",
            "description": "get packs purchased by a specific user"
          },
          {
            "schema": {
              "type": "string"
            },
            "in": "query",
            "name": "factory",
            "description": "get packs created by a specific factory"
          },
          {
            "schema": {
              "type": "string"
            },
            "in": "query",
            "name": "purchase",
            "description": "get packs created in a specific purchase range"
          },
          {
            "schema": {
              "type": "boolean"
            },
            "in": "query",
            "name": "opened",
            "description": "whether these packs have been opened"
          },
          {
            "schema": {
              "type": "boolean"
            },
            "in": "query",
            "name": "fill",
            "description": "whether to fill these packs with their cards"
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "Pack": {
        "description": "",
        "type": "object",
        "x-examples": {
          "example-1": {
            "purchaseid": 36467,
            "purchaseindex": 0,
            "purchaseindices": [
              0,
              1,
              2,
              3,
              4
            ],
            "user": "0x5fafec436b45a12ff430804a644e68cb012e5bd6",
            "factory": "0x0777f76d195795268388789343068e4fcd286919",
            "opened": true,
            "cards": null,
            "type": "rare"
          }
        },
        "properties": {
          "purchaseid": {
            "type": "number"
          },
          "purchaseindex": {
            "type": "number"
          },
          "purchaseindices": {
            "type": "array",
            "items": {
              "type": "number"
            }
          },
          "user": {
            "type": "string",
            "minLength": 1
          },
          "factory": {
            "type": "string",
            "minLength": 1
          },
          "opened": {
            "type": "boolean"
          },
          "cards": {},
          "type": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "purchaseid",
          "purchaseindex",
          "purchaseindices",
          "user",
          "factory",
          "opened",
          "type"
        ]
      },
      "PackList": {
        "description": "",
        "type": "object",
        "x-examples": {
          "example-1": {
            "total": 1377310,
            "page": 1,
            "perPage": 20,
            "records": [
              {
                "purchaseid": 36467,
                "purchaseindex": 0,
                "purchaseindices": [
                  0,
                  1,
                  2,
                  3,
                  4
                ],
                "user": "0x5fafec436b45a12ff430804a644e68cb012e5bd6",
                "factory": "0x0777f76d195795268388789343068e4fcd286919",
                "opened": true,
                "cards": null,
                "type": "rare"
              },
              {
                "purchaseid": 36467,
                "purchaseindex": 5,
                "purchaseindices": [
                  5,
                  6,
                  7,
                  8,
                  9
                ],
                "user": "0x5fafec436b45a12ff430804a644e68cb012e5bd6",
                "factory": "0x0777f76d195795268388789343068e4fcd286919",
                "opened": true,
                "cards": null,
                "type": "rare"
              },
              {
                "purchaseid": 36467,
                "purchaseindex": 10,
                "purchaseindices": [
                  10,
                  11,
                  12,
                  13,
                  14
                ],
                "user": "0x5fafec436b45a12ff430804a644e68cb012e5bd6",
                "factory": "0x0777f76d195795268388789343068e4fcd286919",
                "opened": true,
                "cards": null,
                "type": "rare"
              },
              {
                "purchaseid": 36467,
                "purchaseindex": 15,
                "purchaseindices": [
                  15,
                  16,
                  17,
                  18,
                  19
                ],
                "user": "0x5fafec436b45a12ff430804a644e68cb012e5bd6",
                "factory": "0x0777f76d195795268388789343068e4fcd286919",
                "opened": true,
                "cards": null,
                "type": "rare"
              },
              {
                "purchaseid": 36467,
                "purchaseindex": 20,
                "purchaseindices": [
                  20,
                  21,
                  22,
                  23,
                  24
                ],
                "user": "0x5fafec436b45a12ff430804a644e68cb012e5bd6",
                "factory": "0x0777f76d195795268388789343068e4fcd286919",
                "opened": true,
                "cards": null,
                "type": "rare"
              },
              {
                "purchaseid": 36467,
                "purchaseindex": 25,
                "purchaseindices": [
                  25,
                  26,
                  27,
                  28,
                  29
                ],
                "user": "0x5fafec436b45a12ff430804a644e68cb012e5bd6",
                "factory": "0x0777f76d195795268388789343068e4fcd286919",
                "opened": true,
                "cards": null,
                "type": "rare"
              },
              {
                "purchaseid": 36467,
                "purchaseindex": 30,
                "purchaseindices": [
                  30,
                  31,
                  32,
                  33,
                  34
                ],
                "user": "0x5fafec436b45a12ff430804a644e68cb012e5bd6",
                "factory": "0x0777f76d195795268388789343068e4fcd286919",
                "opened": true,
                "cards": null,
                "type": "rare"
              },
              {
                "purchaseid": 36467,
                "purchaseindex": 35,
                "purchaseindices": [
                  35,
                  36,
                  37,
                  38,
                  39
                ],
                "user": "0x5fafec436b45a12ff430804a644e68cb012e5bd6",
                "factory": "0x0777f76d195795268388789343068e4fcd286919",
                "opened": true,
                "cards": null,
                "type": "rare"
              },
              {
                "purchaseid": 36467,
                "purchaseindex": 40,
                "purchaseindices": [
                  40,
                  41,
                  42,
                  43,
                  44
                ],
                "user": "0x5fafec436b45a12ff430804a644e68cb012e5bd6",
                "factory": "0x0777f76d195795268388789343068e4fcd286919",
                "opened": true,
                "cards": null,
                "type": "rare"
              },
              {
                "purchaseid": 36467,
                "purchaseindex": 45,
                "purchaseindices": [
                  45,
                  46,
                  47,
                  48,
                  49
                ],
                "user": "0x5fafec436b45a12ff430804a644e68cb012e5bd6",
                "factory": "0x0777f76d195795268388789343068e4fcd286919",
                "opened": true,
                "cards": null,
                "type": "rare"
              },
              {
                "purchaseid": 36467,
                "purchaseindex": 50,
                "purchaseindices": [
                  50,
                  51,
                  52,
                  53,
                  54
                ],
                "user": "0x5fafec436b45a12ff430804a644e68cb012e5bd6",
                "factory": "0x0777f76d195795268388789343068e4fcd286919",
                "opened": true,
                "cards": null,
                "type": "rare"
              },
              {
                "purchaseid": 36467,
                "purchaseindex": 55,
                "purchaseindices": [
                  55,
                  56,
                  57,
                  58,
                  59
                ],
                "user": "0x5fafec436b45a12ff430804a644e68cb012e5bd6",
                "factory": "0x0777f76d195795268388789343068e4fcd286919",
                "opened": true,
                "cards": null,
                "type": "rare"
              },
              {
                "purchaseid": 36467,
                "purchaseindex": 60,
                "purchaseindices": [
                  60,
                  61,
                  62,
                  63,
                  64
                ],
                "user": "0x5fafec436b45a12ff430804a644e68cb012e5bd6",
                "factory": "0x0777f76d195795268388789343068e4fcd286919",
                "opened": true,
                "cards": null,
                "type": "rare"
              },
              {
                "purchaseid": 36467,
                "purchaseindex": 65,
                "purchaseindices": [
                  65,
                  66,
                  67,
                  68,
                  69
                ],
                "user": "0x5fafec436b45a12ff430804a644e68cb012e5bd6",
                "factory": "0x0777f76d195795268388789343068e4fcd286919",
                "opened": true,
                "cards": null,
                "type": "rare"
              },
              {
                "purchaseid": 36467,
                "purchaseindex": 70,
                "purchaseindices": [
                  70,
                  71,
                  72,
                  73,
                  74
                ],
                "user": "0x5fafec436b45a12ff430804a644e68cb012e5bd6",
                "factory": "0x0777f76d195795268388789343068e4fcd286919",
                "opened": true,
                "cards": null,
                "type": "rare"
              },
              {
                "purchaseid": 36467,
                "purchaseindex": 75,
                "purchaseindices": [
                  75,
                  76,
                  77,
                  78,
                  79
                ],
                "user": "0x5fafec436b45a12ff430804a644e68cb012e5bd6",
                "factory": "0x0777f76d195795268388789343068e4fcd286919",
                "opened": true,
                "cards": null,
                "type": "rare"
              },
              {
                "purchaseid": 36467,
                "purchaseindex": 80,
                "purchaseindices": [
                  80,
                  81,
                  82,
                  83,
                  84
                ],
                "user": "0x5fafec436b45a12ff430804a644e68cb012e5bd6",
                "factory": "0x0777f76d195795268388789343068e4fcd286919",
                "opened": true,
                "cards": null,
                "type": "rare"
              },
              {
                "purchaseid": 36467,
                "purchaseindex": 85,
                "purchaseindices": [
                  85,
                  86,
                  87,
                  88,
                  89
                ],
                "user": "0x5fafec436b45a12ff430804a644e68cb012e5bd6",
                "factory": "0x0777f76d195795268388789343068e4fcd286919",
                "opened": true,
                "cards": null,
                "type": "rare"
              },
              {
                "purchaseid": 36467,
                "purchaseindex": 90,
                "purchaseindices": [
                  90,
                  91,
                  92,
                  93,
                  94
                ],
                "user": "0x5fafec436b45a12ff430804a644e68cb012e5bd6",
                "factory": "0x0777f76d195795268388789343068e4fcd286919",
                "opened": true,
                "cards": null,
                "type": "rare"
              },
              {
                "purchaseid": 36467,
                "purchaseindex": 95,
                "purchaseindices": [
                  95,
                  96,
                  97,
                  98,
                  99
                ],
                "user": "0x5fafec436b45a12ff430804a644e68cb012e5bd6",
                "factory": "0x0777f76d195795268388789343068e4fcd286919",
                "opened": true,
                "cards": null,
                "type": "rare"
              }
            ]
          }
        },
        "properties": {
          "total": {
            "type": "number"
          },
          "page": {
            "type": "number"
          },
          "perPage": {
            "type": "number"
          },
          "records": {
            "type": "array",
            "uniqueItems": true,
            "minItems": 1,
            "items": {
              "$ref": "#/components/schemas/Pack"
            }
          }
        },
        "required": [
          "total",
          "page",
          "perPage",
          "records"
        ]
      }
    },
    "parameters": {
      "page": {
        "name": "page",
        "in": "query",
        "required": false,
        "schema": {
          "type": "number"
        },
        "description": "page number"
      },
      "perPage": {
        "name": "perPage",
        "in": "query",
        "required": false,
        "schema": {
          "type": "number"
        },
        "description": "number of items per page to return"
      },
      "sort": {
        "name": "sort",
        "in": "query",
        "schema": {
          "type": "string"
        }
      },
      "order": {
        "name": "order",
        "in": "query",
        "schema": {
          "type": "string",
          "enum": [
            "asc",
            "desc"
          ]
        }
      },
      "type": {
        "name": "type",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "creature",
            "spell",
            "weapon"
          ]
        },
        "description": "card type"
      }
    }
  },
  "tags": [
    {
      "name": "pack"
    }
  ],
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 97,
      "1": 222,
      "2": 72,
      "3": 136,
      "4": 234,
      "5": 204,
      "6": 69,
      "7": 0,
      "8": 66,
      "9": 174,
      "10": 18,
      "11": 91
    }
  }
}
```