Skip to main content
GET
/
collections
/
{id}
Get Collection
curl --request GET \
  --url https://api.loopreturns.com/api/v1/collections/{id} \
  --header 'X-Authorization: <api-key>'
{
  "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)"

Path Parameters

​
id
integer
required

The unique identifier for the collection, created by Loop.

Example:

23141001200513

Response

Success

​
id
integer<int64>

The unique identifier for the collection, created by Loop.

​
external_id
string | null

The identifier used by an external source to identify the collection.

​
channel
string

The name of the channel.

​
name
string

The name of the collection.

​
products
ProductResponse · object[] | null

An array of products associated with the collection.