Collection Object

Description

Represents a curated collection of items with filtering and display settings.

Declaration

type Collection {
    _id: ID!
    created: Date
    createdBy: UserReference
    id: Int!
    title: String!
    description: CollectionDescription
    handle: String!
    sort: CollectionSort
    viewType: String
    seo: SeoEntry
    path: String
    banner: CollectionBanner
    segments: [CollectionSegment!]!
}

Fields

Name	Type	Description
_id	ID!	Internal database identifier.
created	Date	Date when the collection was created.
createdBy	UserReference	User who created the collection.
id	Int!	Numeric identifier for the collection.
title	String!	Title of the collection.
description	CollectionDescription	Description of the collection.
handle	String!	URL-friendly handle for the collection.
sort	CollectionSort	Default sort configuration for the collection.
viewType	String	View type for displaying the collection (e.g., "tile", "list", "full").
seo	SeoEntry	SEO metadata for the collection.
path ⚠️	String	URL path to the collection page. This field is deprecated. ⚠️ Deprecated: No longer supported
banner	CollectionBanner	Banner image for the collection.
segments	[CollectionSegment!]!	Segments defining filter criteria for the collection.