Medusa
Store APIAdmin API
Store APIAdmin API
Discord
Twitter
Linkedin
Github
  1. Collections
  • Introduction
  • Authentication
  • HTTP Compression
  • Publishable API Key
  • Expanding Fields
  • Selecting Fields
  • Query Parameter Types
  • Pagination
  • Currencies
    • List Currencies
      GET
    • Get a Currency
      GET
  • Payment Providers
    • List Payment Providers
      GET
  • Return Reasons
    • List Return Reasons
      GET
    • Get a Return Reason
      GET
  • Auth
    • Retrieve Registration JWT Token
      POST
    • Authenticate Customer
      POST
    • Generate Reset Password Token for Customer
      POST
    • Refresh Authentication Token
      POST
    • Validate Authentication Callback
      POST
    • Delete Authentication Session
      DELETE
    • Set Authentication Session
      POST
    • Reset a Customer's Password
      POST
  • Collections
    • List Collections
      GET
    • Get a Collection
      GET
  • Regions
    • List Regions
      GET
    • Get a Region
      GET
  • Products
    • List Products
    • Get a Product
  • Customers
    • Get Logged-in Customer
    • Update Customer
    • Create Address for Logged-In Customer
    • List Customer's Addresses
    • Get Customer's Address
    • Update Customer's Address
    • Remove Customer's Address
    • Register Customer
  • Product Tags
    • List Product Tags
    • Get a Product Tag
  • Returns
    • Create Return
  • Product Types
    • Get a Product Type
    • List Product Types
  • Product Categories
    • List Product Categories
    • Get a Product Category
  • Carts
    • Create Cart
    • Set Cart's Customer
    • Add Shipping Method to Cart
    • Add Line Item to Cart
    • Calculate Cart Taxes
    • Get a Cart
    • Update a Cart
    • Update a Line Item in a Cart
    • Remove Line Item from Cart
    • Complete Cart
    • Add Promotions to Cart
    • Remove Promotions from Cart
  • Orders
    • List Logged-in Customer's Orders
    • Request Order Transfer
    • Get an Order
    • Cancel Order Transfer
    • Decline Order Transfer
    • Accept Order Transfer
  • Payment Collections
    • Initialize Payment Session of a Payment Collection
    • Create Payment Collection
  • Shipping Options
    • Calculate Shipping Option Price
    • List Shipping Options for Cart
  1. Collections

List Collections

GET
/store/collections
Retrieve a list of collections. The collections can be filtered by fields such as handle. The collections can also be sorted or paginated.
Request Request Example
JavaScript
Shell
Java
Swift
curl --location -g --request GET '{{BASE_URL}}/store/collections' \
--header 'x-publishable-api-key;'
Response Response Example
200 - Example 1
{
    "limit": 0,
    "offset": 0,
    "count": 0,
    "collections": [
        {
            "id": "string",
            "title": "string",
            "handle": "string",
            "created_at": "2019-08-24T14:15:22Z",
            "updated_at": "2019-08-24T14:15:22Z",
            "deleted_at": "2019-08-24T14:15:22Z",
            "metadata": {},
            "products": [
                {}
            ]
        }
    ]
}

Request

Query Params
fields
string 
fields
optional
Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.
offset
number 
offset
optional
The number of items to skip when retrieving a list.
limit
number 
limit
optional
Limit the number of items returned in the list.
order
string 
order
optional
The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with -.
title
optional
One of
Filter by a collection's title.
$ne
array[string]
optional
Filter by values not equal to this parameter.
Example:
["",""]
$gt
array[string]
optional
Filter by values greater than this parameter. Useful for numbers and dates only.
Example:
["",""]
$gte
array[string]
optional
Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
Example:
["",""]
$lt
array[string]
optional
Filter by values less than this parameter. Useful for numbers and dates only.
Example:
["",""]
$lte
array[string]
optional
Filter by values less than or equal to this parameter. Useful for numbers and dates only.
Example:
["",""]
$like
array[string]
optional
Apply a like filter. Useful for strings only.
Example:
["",""]
$re
array[string]
optional
Apply a regex filter. Useful for strings only.
Example:
["",""]
$ilike
array[string]
optional
Apply a case-insensitive like filter. Useful for strings only.
Example:
["",""]
$fulltext
array[string]
optional
Filter to apply on full-text properties.
Example:
["",""]
$exists
array[string]
optional
Filter by whether a value for this parameter exists (not null).
Example:
["",""]
$and
array [object] 
$and
optional
Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
Example:
["",""]
$or
array [object] 
$or
optional
Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
Example:
["",""]
$in
array[string]
optional
Filter by values in this array.
Example:
["",""]
$nin
array[string]
optional
Filter by values not in this array.
Example:
["",""]
$overlap
array[string]
optional
Filter arrays that have overlapping values with this parameter.
Example:
["",""]
$contains
array[string]
optional
Filter arrays that contain some of the values of this parameter.
Example:
["",""]
$contained
array[string]
optional
Filter arrays that contain all values of this parameter.
Example:
["",""]
$eq
array[string]
optional
Example:
["",""]
$not
array[string]
optional
Example:
["",""]
handle
optional
One of
Filter by a collection's handle.
q
string 
q
optional
Search term to filter the collection's searchable properties.
Header Params
x-publishable-api-key
string 
required
Publishable API Key created in the Medusa Admin.

Responses

🟢200OK
application/json
OK
Body
The paginated list of collections.
limit
number 
limit
required
The maximum number of items returned.
offset
number 
offset
required
The number of items skipped before retrieving the returned items.
count
number 
count
required
The total number of items.
collections
array[object (StoreCollection) {8}] 
required
The collection's collections.
id
string 
id
required
The collection's ID.
title
string 
title
required
The collection's title.
handle
string 
handle
required
The collection's handle.
created_at
string <date-time>
created_at
required
The date the collection was created.
updated_at
string <date-time>
updated_at
required
The date the collection was updated.
deleted_at
string <date-time>
deleted_at
required
The date the collection was deleted.
metadata
object 
required
The collection's metadata, can hold custom key-value pairs.
products
array [object] 
optional
The collection's products.
🟠400Bad Request
🟠401Unauthorized
🟠404Record Not Found
🟠409409
🟠422Parameter Error
🔴500Server Error
Modified at 2025-06-17 04:21:30
Previous
Reset a Customer's Password
Next
Get a Collection
Built with