Skip to main content
GET
/
collections
List Collections
curl --request GET \
  --url https://api.loopreturns.com/api/v1/collections \
  --header 'X-Authorization: <api-key>'
{
  "collections": [
    {
      "id": 123,
      "external_id": "<string>",
      "channel": "<string>",
      "name": "<string>",
      "products": [
        {
          "id": 2,
          "external_id": "<string>",
          "sku": "<string>",
          "name": "<string>"
        }
      ]
    }
  ]
}

Authorizations

X-Authorization
string
header
required

API Scope: "Collections (read)"

Query Parameters

external_id
string

An external_id used to filter the collections.

limit
integer
default:50

The maximum number of collections returned.

Required range: 1 <= x <= 250
sort_order
enum<string>
default:asc

The sort order for the results.

Available options:
asc,
desc
cursor
string

The cursor to return the next page of results.

Response

Success

collections
object[]