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": "dbeba216-7e87-442d-917c-b34b0ac6d5bc",
  "workspace_id": "ad9b8983-8c02-4384-aa78-579026b66fc0",
  "title": "Office Favorites",
  "is_published": true,
  "published_price": null,
  "product": null,
  "published_version": {
    "id": "d2324d4a-32d7-4d54-bb2f-6b6ee01600ca",
    "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,
    "header_image": null,
    "collection_categories": [
      {
        "id": "e2364aa6-7f08-40bb-806c-69f6911f6db6",
        "name": "Treats & Sips",
        "is_featured": true,
        "position": 1,
        "collection_products": [
          {
            "id": "4f9571e8-4440-4eaa-97c0-3ffa04b2db54",
            "product": {
              "id": "654f95a8-f297-4e44-9a7c-7f7e70e5425d",
              "name": "Craft Coffee Kit",
              "brand": {
                "id": "6a7cb322-6a77-4f2e-ba20-137aec234396",
                "name": "Cookie Company",
                "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": "2025-11-05T10:22:13Z",
              "status": "active"
            }
          },
          {
            "id": "6b4ef812-0470-4b71-b1b2-86c6281bff6b",
            "product": {
              "id": "73fe3955-ed57-444b-b7c9-a05ee9df7189",
              "name": "Artisan Snack Box",
              "brand": {
                "id": "6a7cb322-6a77-4f2e-ba20-137aec234396",
                "name": "Cookie Company",
                "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": "2025-11-05T10:22:13Z",
              "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.