Skip to main content
GET
/
v2
/
products
Get products
curl --request GET \
  --url https://api.snappy.com/public-api/v2/products \
  --header 'X-Api-Key: <api-key>'
{
  "results": [
    {
      "id": "string",
      "title": "string",
      "category": "string",
      "brand": {
        "id": "abCd57eFG0",
        "name": "Brand Name",
        "description": "Brand Description"
      },
      "coverImage": {
        "position": 1,
        "type": "image",
        "publicCloudinaryId": "bnxjv94tmzq1w8eplk73ua_picture-1.png",
        "src": "https://example.com/bnxjv94tmzq1w8eplk73ua_picture-1.png"
      },
      "options": {
        "takeYourPick": "Rainbow Bagel Making Kit",
        "color": "Black",
        "size": "S",
        "scent": "Lavender",
        "flavor": "Chocolate",
        "beverageType": "Coffee"
      },
      "tags": [
        {
          "id": "tag12345A",
          "name": "Tag Name",
          "color": "#000000",
          "position": 1
        }
      ],
      "variants": [
        {
          "id": "ab6789cd",
          "optionAttributes": {
            "takeYourPick": "Rainbow Bagel Making Kit",
            "color": "Black",
            "size": "S",
            "scent": "Lavender",
            "flavor": "Chocolate",
            "beverageType": "Coffee"
          },
          "brand": {
            "id": "abCd57eFG0",
            "name": "Brand Name",
            "description": "Brand Description"
          },
          "components": "string",
          "description": "Variant description",
          "features": "Variant features",
          "category": "Electronics / Audio / Headphones / Wireless Earbuds",
          "mediaItems": [
            {
              "position": 1,
              "type": "image",
              "publicCloudinaryId": "bnxjv94tmzq1w8eplk73ua_picture-1.png",
              "src": "https://example.com/bnxjv94tmzq1w8eplk73ua_picture-1.png"
            }
          ],
          "position": 0,
          "types": [
            "digital"
          ],
          "tags": [
            {
              "id": "tag12345A",
              "name": "Tag Name",
              "color": "#000000",
              "position": 1
            }
          ],
          "title": "Variant title",
          "information": {
            "including": "<ul><li>Cute puppy</li></ul>",
            "description": "<p>Cutest puppy in the world</p>",
            "features": "<ul><li>Floppy ears</li><li>Big eyes</li></ul>",
            "specifications": {
              "colorFamily": "Brown",
              "dimensions": "37in x17in 6in",
              "materials": "Cotton",
              "weight": "1.5 lbs"
            }
          },
          "notices": {
            "additionalProp1": "string",
            "additionalProp2": "string",
            "additionalProp3": "string"
          },
          "pricing": {
            "US": {
              "cost": 100,
              "totalFee": 2,
              "totalTax": 7,
              "totalFinalCost": 109
            }
          },
          "supportedCountries": [
            {
              "countryCode": "US"
            },
            {
              "countryCode": "CA"
            },
            {
              "countryCode": "GB"
            },
            {
              "countryCode": "DE"
            },
            {
              "countryCode": "FR"
            }
          ]
        }
      ],
      "types": [
        "digital"
      ],
      "mediaItems": [
        {
          "position": 1,
          "type": "image",
          "publicCloudinaryId": "bnxjv94tmzq1w8eplk73ua_picture-1.png",
          "src": "https://example.com/bnxjv94tmzq1w8eplk73ua_picture-1.png"
        }
      ],
      "notices": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      }
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.snappy.com/llms.txt

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

Authorizations

​
X-Api-Key
string
header
required

Company Level Authentication

Company level authentication provides access to all resources under your company, including accounts, campaigns, gifts, and recipients.

Getting Your API Key

  1. Create an API Key: Use the POST /v2/authentication/apiKeys endpoint to generate a new API key
  2. Set Expiration: Choose from 30, 60, 90, or 180 days (default: 90 days)
  3. Optional mTLS: Enable mutual TLS for enhanced security
  4. Name Your Key: Provide a descriptive name for easy identification

Using Your API Key

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

X-Api-Key: YOUR_24_CHARACTER_API_KEY

API Key Management

  • Maximum Keys: Up to 3 active API keys per company
  • Rotation: Delete old keys before creating new ones when at the limit
  • Security: Keys are hashed and cannot be retrieved after creation

Enhanced Security (mTLS)

For production environments, enable mutual TLS authentication:

  1. Set enforceMtls: true when creating the API key
  2. Contact support to obtain your client certificates
  3. Use the mTLS endpoint: https://mtls-api.snappy.com/public-api

Headers

​
Request-Source
enum<string>

Source of the request

Available options:
api_native,
api_zapier,
api_salesforce,
api_ftp,
api_make
Example:

"api_native"

Query Parameters

​
minBudget
number
required

Minimum budget

Required range: 1 <= x <= 20000
Example:

1

​
maxBudget
number
required

Maximum budget

Required range: 1 <= x <= 20000
Example:

10000

​
collectionId
string

Collection ID. Used when "brandName", "brands", "tags", "title", "description" are not provided.

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

"abcdef12"

​
brandName
string

Brand name. Used when "collectionId" is not provided.

Example:

"abc123"

​
brands
string[]

List of product brand IDs. Used when "collectionId" is not provided.

Minimum array length: 1
Example:
["abc123"]
​
tags
string[]

List of hash tag IDs. Used when "collectionId" is not provided.

Minimum array length: 1
Example:
["abc123"]
​
title
string

Product title. Used when "collectionId" is not provided.

Example:

"abc123"

​
description
string

Product description. Used when "collectionId" is not provided.

Example:

"abc123"

​
skip
number | null
default:0

Number of records to skip for pagination (use with limit for paging through results)

Required range: x >= 0
Example:

0

​
limit
number
default:100

Maximum number of records to return per page

Required range: 1 <= x <= 100
Example:

10

​
companyId
string

Company ID

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

"12345678"

​
country
string
default:US
​
accountId
string

Account ID

Example:

"a12bcd34"

​
fields
enum<string>[]

List of additional fields to include in response objects

Minimum array length: 1

The fields to return additionally in response. Valid values are: mediaItems, tags, brand, optionAttributes, notices, pricing, supportedCountries, full.

Available options:
mediaItems,
tags,
brand,
optionAttributes,
notices,
pricing,
supportedCountries,
full
Example:
["full"]

Response

Successful response

Response containing products.

​
results
object[]
required

The fetched products.

Last modified on April 16, 2026