Get collection by ID

curl --request GET \
  --url https://api.snappy.com/public-api/v3/collections/{collectionId} \
  --header 'X-Api-Key: <api-key>' \
  --header 'snappy-account-id: <snappy-account-id>'

{
  "data": {
    "id": "64a1234567890abcdef12345",
    "name": "Birthday Gifts",
    "tags": [
      "gifts"
    ],
    "media": [
      {
        "type": "image",
        "src": "https://media.snappy.com/image/o1xc17wfbda6cl91hm0r6_picture-1.jpg?w=1000&h=1000&q=80&f=auto"
      }
    ],
    "coverImage": {
      "type": "image",
      "src": "https://media.snappy.com/image/o1xc17wfbda6cl91hm0r6_picture-1.jpg?w=1000&h=1000&q=80&f=auto"
    },
    "rank": 10,
    "description": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "priceRange": {
      "min": 25,
      "max": 200
    },
    "createdVia": "dashboard"
  }
}

Collections

Get collection by ID

Use this endpoint to retrieve a single Collection’s full metadata - name, description, cover image, thumbnails, rank, and provenance. Use this when rendering a Collection detail page before drilling into its Products via GET /v3/collections/{collectionId}/products.

Required path parameters

collectionId - the Collection identifier.

Optional query parameters

filter[location] - comma-separated ISO 3166-1 alpha-2 country codes. Thumbnails and priceRange use the first location. Defaults to US.
filter[maxPrice] - budget bucket selector that controls which thumbnail set is returned.
fields - comma-separated list of optional fields to include. One or more of priceRange, updatedBy, createdVia.

Required headers

Snappy-Account-Id - account scope.

Optional headers

Snappy-Company-Id - further scope to a specific Company within the Account.

Please note

Always returns id, name, description, tags, media, coverImage, rank, createdBy, createdAt, and updatedAt. The fields parameter adds the listed optional fields on top of these defaults.
Returns 404 (404_PBLC_004) if the Collection is not found or is not visible to the calling Account. The two cases are intentionally indistinguishable - visibility is treated as identical to non-existence to avoid leaking other Accounts’ Collections.

Permissions

Requires: collections:read

GET

collections

{collectionId}

Get collection by ID

curl --request GET \
  --url https://api.snappy.com/public-api/v3/collections/{collectionId} \
  --header 'X-Api-Key: <api-key>' \
  --header 'snappy-account-id: <snappy-account-id>'

{
  "data": {
    "id": "64a1234567890abcdef12345",
    "name": "Birthday Gifts",
    "tags": [
      "gifts"
    ],
    "media": [
      {
        "type": "image",
        "src": "https://media.snappy.com/image/o1xc17wfbda6cl91hm0r6_picture-1.jpg?w=1000&h=1000&q=80&f=auto"
      }
    ],
    "coverImage": {
      "type": "image",
      "src": "https://media.snappy.com/image/o1xc17wfbda6cl91hm0r6_picture-1.jpg?w=1000&h=1000&q=80&f=auto"
    },
    "rank": 10,
    "description": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "priceRange": {
      "min": 25,
      "max": 200
    },
    "createdVia": "dashboard"
  }
}

Authorizations

X-Api-Key

string

header

required

Company Level Authentication

Include your API key in the X-Api-Key header for every request:

X-Api-Key: YOUR_API_KEY

Headers

snappy-account-id

string

required

Account identifier.

Example:

"acc123456"

snappy-company-id

string

Optional company identifier.

Example:

"cmp123456"

Path Parameters

collectionId

string

required

Collection identifier.

Pattern: ^[A-Za-z0-9]{8,}$

Example:

"abcdef12"

Query Parameters

filter[location]

string

default:US

Comma-separated ISO 3166-1 alpha-2 country codes. Thumbnails and budget data use the first location.

Pattern: ^([A-Z]{2})(,[A-Z]{2})*$

Example:

"US"

filter[maxPrice]

number | null

Budget bucket selector for thumbnails.

Required range: 0 <= x <= 99999

Example:

80

fields

enum<string>[]

Optional fields: priceRange, createdVia.

Available options:

priceRange,

createdVia

Example:

["priceRange"]

Response

A single collection resource.

Single collection response envelope.

data

object

required

Collection resource.

Show child attributes

Last modified on June 24, 2026

Get collections

Get collection products