Skip to main content
GET
Retrieve a collection
Retrieve a collection’s details. Automation API only. To access the products in a collection, traverse: collection > published_version > collection_categories > collection_products > product.

Authorizations

Authorization
string
header
required

Your Goody API key.

Path Parameters

id
string
required

Collection ID

Response

Collection retrieved successfully

A collection is a curated group of products that recipients can select from.

id
string<uuid>
required
workspace_id
string<uuid>
required

Workspace that owns this collection.

is_published
boolean
required

Indicates whether the collection currently has a published version.

title
string | null
published_price
integer | null

Price for the published collection in cents, including shipping.

product
object | null

The product that represents the collection when published. Null for unpublished collections. To send this collection, send the product ID in the cart

published_version
object | null

Details about the published version of this collection. Null for unpublished collections.