Skip to main content
GET
Get base products

Authorizations

X-Api-Key
string
header
required

Company Level Authentication

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

Headers

snappy-account-id
string
required

Required. Account identifier.

Minimum string length: 1
Example:

"acc123456"

Query Parameters

filter[brandId]
string[]

Comma-separated list of brand ids (OR semantics).

Minimum string length: 1
Example:
filter[brandName]
string

Case-insensitive substring search on brand name.

Minimum string length: 1
Example:

"Cotopaxi"

filter[tagId]
string<uuid>[]

Comma-separated list of tag UUIDs (OR semantics). Each value must be a valid UUID.

Example:
filter[title]
string

Case-insensitive substring search on title.

Minimum string length: 1
Example:

"Classic Tee"

filter[id]
string<uuid>[]

Comma-separated list of base-product UUIDs.

Example:
filter[color]
string[]

Comma-separated color titles.

Minimum string length: 1
Example:
filter[size]
string[]

Comma-separated size titles.

Minimum string length: 1
Example:
filter[printingTechnique]
enum<string>[]

Comma-separated printing-technique display names.

Supported printing-technique display name.

Available options:
Direct to film,
Direct to garment,
Embroidery,
Sublimation,
Digital inkjet,
Laser printing,
UV printing,
Digital printing
Example:
fields
enum<string>[]

Comma-separated list of expanded base-product fields.

  • options - includes the aggregated variant options array.
  • printingTechnique - includes the printing technique display name, or null when none applies.

When omitted, expanded fields are not returned.

Expanded fields for a swag base product. options returns the aggregated variant options array, and printingTechnique returns the printing technique display name or null.

Available options:
options,
printingTechnique
Example:
include
enum<string>[]

Related entities to include. brand and tags are returned only when requested.

Related entities to include with a swag base product. brand and tags are returned only when requested.

Available options:
brand,
tags
Example:
page[number]
integer
default:1

1-indexed page number.

Required range: x >= 1
Example:

1

page[size]
integer
default:100

Number of base products per page (max 300, default 100).

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

100

location
string
required

Required ISO 3166-1 alpha-2 country code.

Pattern: ^[A-Z]{2}$
Example:

"US"

Response

Paginated list of base products.

Paginated base product list response (page-number pagination).

data
object[]
required

Base products for the requested page.

Top-level JSON:API-style pagination links for paginated list responses. first, next, and prev are all required and all nullable. prev is null on cursor-paginated endpoints (backward navigation not supported).

Last modified on September 23, 2026