List Collections

Returns collections list.

Query Parameters

Parameter	Type	Default	Description
per_page	integer	100	Number of results to be returned per request (100 is the maximum)
page_no	integer	1	Number of results page
include_total	boolean	false	When true, detailed pagination info (containing info like total records count, next page) will be returned
sort_by	string	"name"	What attribute should results be sorted by? Supported attributes are: `["title", "created_at", "updated_at"]`
sort_direction	string	"asc"	Direction of sorting: "asc" or "desc"
with_archived	boolean	false	When present, also archived records will be returned
scope	enum (see: Offer scope)	null	When present, returns only collections destined for this scope

All parameters are optional.

Key	Type	Optional?	Description
collections Collection[]	no (may be empty)	See Collection model
pagination_info	PaginationInfo	no	See Pagination info model

When successful, returns a list of collections and collections

{
  "collections": [
    {
      // (...) - see Collection model
    }
  ],
  "pagination_info": {
      // (...) - see Pagination info model
  }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Ruby