List Collections
Retrieve a list of collections. The collections can be filtered by fields such as handle
. The collections can also be sorted or paginated.
Headers
Publishable API Key created in the Medusa Admin.
Query Parameters
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.
The number of items to skip when retrieving a list.
Limit the number of items returned in the list.
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 -
.
Filter by a collection's title.
Filter by the collection's creation date.
Filter by the collection's update date.
Filter by a collection's handle.
Search term to filter the collection's searchable properties.
Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
Whether to include deleted records in the result.
Response
OK
The paginated list of collections.