Skip to main content
GET
/
v1
/
collections
/
{id}
Retrieve a collection
curl --request GET \
  --url https://api.ongoody.com/v1/collections/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "eb3a80be-a83d-4b6d-b57a-1b493e00b7eb",
  "workspace_id": "c761e341-4f13-496d-8b10-ac753655e969",
  "title": "Office Favorites",
  "is_published": true,
  "published_price": null,
  "product": null,
  "published_version": {
    "id": "115e9dbe-550e-426c-9dae-0cc19908669e",
    "title": "Office Favorites",
    "subtitle": "Curated treats for the whole team",
    "multiple_select_mode": "disabled",
    "multiple_select_count": null,
    "multiple_select_price": null,
    "international_shipping_tier": "standard",
    "international_gift_cards_enabled": false,
    "display_interface": "single_page",
    "header_image": null,
    "collection_categories": [
      {
        "id": "0fb5b47b-1f66-4692-be39-cf32cbb3315d",
        "name": "Treats & Sips",
        "is_featured": true,
        "position": 1,
        "collection_products": [
          {
            "id": "3206bffb-2d37-424b-8db1-3fafc3f66df1",
            "product": {
              "id": "f9b6c406-7a51-4907-828a-08ae25eb5f03",
              "name": "Craft Coffee Kit",
              "brand": {
                "id": "039f71b5-ed68-405b-9869-325726b8d91d",
                "name": "Cookie Company",
                "logo_image": null,
                "shipping_price": 1000,
                "free_shipping_minimum": null,
                "brand_values": []
              },
              "subtitle": null,
              "subtitle_short": null,
              "recipient_description": "",
              "variants_label": null,
              "variants_num_selectable": null,
              "variants": [],
              "variant_groups": [],
              "images": [],
              "price": 1000,
              "price_is_variable": false,
              "restricted_states": [],
              "attributes": [],
              "updated_at": "2026-03-26T17:02:32Z",
              "status": "active"
            }
          },
          {
            "id": "5ec7c15c-3da2-449a-9cf2-232346f049a6",
            "product": {
              "id": "b6b85d9a-0b18-4ff5-8bb9-12278f5069ad",
              "name": "Artisan Snack Box",
              "brand": {
                "id": "039f71b5-ed68-405b-9869-325726b8d91d",
                "name": "Cookie Company",
                "logo_image": null,
                "shipping_price": 1000,
                "free_shipping_minimum": null,
                "brand_values": []
              },
              "subtitle": null,
              "subtitle_short": null,
              "recipient_description": "",
              "variants_label": null,
              "variants_num_selectable": null,
              "variants": [],
              "variant_groups": [],
              "images": [],
              "price": 1000,
              "price_is_variable": false,
              "restricted_states": [],
              "attributes": [],
              "updated_at": "2026-03-26T17:02:32Z",
              "status": "active"
            }
          }
        ]
      }
    ]
  }
}
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

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

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