Skip to main content
GET
/
v1
/
collections
List collections
curl --request GET \
  --url https://api.ongoody.com/v1/collections \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "d24c055a-27c2-4a80-98e5-48e1d3300730",
      "workspace_id": "c761e341-4f13-496d-8b10-ac753655e969",
      "title": "Embrace Rich Experiences",
      "is_published": false,
      "published_price": null,
      "product": null,
      "published_version": null
    },
    {
      "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
      }
    }
  ],
  "list_meta": {
    "total_count": 2
  }
}

Documentation Index

Fetch the complete documentation index at: https://developer.ongoody.com/llms.txt

Use this file to discover all available pages before exploring further.

Retrieve all collections in all workspaces you have access to. Automation API only. To filter to only published collections, use querystring ?published=true.

Authorizations

​
Authorization
string
header
required

Your Goody API key.

Query Parameters

​
page
integer
default:1

Page number for pagination (starts at 1)

Required range: x >= 1
​
per_page
integer
default:20

Number of collections to return per page (maximum 100)

Required range: 1 <= x <= 100
​
published
boolean

Return only published collections when true

Response

200 - application/json

Collections retrieved successfully

​
data
object[]
​
list_meta
object