Get products
Use this endpoint to search for and retrieve a list of available products based on your specified criteria - including budget range, Collection, brand, tags, or free-text search on title and description.
Required fields:
minBudgetquery parameter - inclusive minimum budget (1-20,000)maxBudgetquery parameter - inclusive maximum budget (1-20,000)
Filtering options:
collectionId- scope search to a specific Collection. When supplied,brandName,brands,tags,title, anddescriptionare ignored.brandName- brand name match (used whencollectionIdis not provided)brands- comma-separated list of brand IDs (used whencollectionIdis not provided)tags- comma-separated list of tag IDs (used whencollectionIdis not provided)title- product title match (used whencollectionIdis not provided)description- product description match (used whencollectionIdis not provided)countryquery parameter - ISO 3166-1 alpha-2 country code (defaultUS)companyId/accountId- scoping parametersfieldsquery parameter - comma-separated field projection. Valid values:mediaItems,tags,brand,optionAttributes,notices,pricing,supportedCountries,fullRequest-Sourceheader - source of the request (api_native,api_zapier,api_salesforce,api_ftp,api_make)
Pagination:
skipquery parameter - number of records to skip (default0)limitquery parameter - max records per page (1-100, default100)
Please note:
collectionIdis mutually exclusive with the other text/brand/tag filters. Supplying both will usecollectionIdand ignore the others.- Returns
422when the suppliedcollectionIddoesn’t exist or isn’t accessible.
Permissions
- Requires:
products:read
Authorizations
Company Level Authentication
Company level authentication provides access to all resources under your company, including accounts, campaigns, gifts, and recipients.
Getting Your API Key
- Create an API Key: Use the
POST /v2/authentication/apiKeysendpoint to generate a new API key - Set Expiration: Choose from 30, 60, 90, or 180 days (default: 90 days)
- Optional mTLS: Enable mutual TLS for enhanced security
- 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:
- Set
enforceMtls: truewhen creating the API key - Contact support to obtain your client certificates
- Use the mTLS endpoint:
https://mtls-api.snappy.com/public-api
Headers
Source of the request
api_native, api_zapier, api_salesforce, api_ftp, api_make "api_native"
Query Parameters
Minimum budget
1 <= x <= 200001
Maximum budget
1 <= x <= 2000010000
Collection ID. Used when "brandName", "brands", "tags", "title", "description" are not provided.
^[A-Za-z0-9]{8,}$"abcdef12"
Brand name. Used when "collectionId" is not provided.
"abc123"
List of product brand IDs. Used when "collectionId" is not provided.
1["abc123"]
List of hash tag IDs. Used when "collectionId" is not provided.
1["abc123"]
Product title. Used when "collectionId" is not provided.
"abc123"
Product description. Used when "collectionId" is not provided.
"abc123"
Number of records to skip for pagination (use with limit for paging through results)
x >= 00
Maximum number of records to return per page
1 <= x <= 10010
Company ID
^[A-Za-z0-9]{8,}$"12345678"
Account ID
"a12bcd34"
List of additional fields to include in response objects
1The fields to return additionally in response. Valid values are: mediaItems, tags, brand, optionAttributes, notices, pricing, supportedCountries, full.
mediaItems, tags, brand, optionAttributes, notices, pricing, supportedCountries, full ["full"]
Response
Successful response
Response containing products.
The fetched products.