Get collections
Use this endpoint to search for and retrieve a list of available Collections based on your specified criteria, including budget range, supported countries, and Collection type.
Required fields:
budgetquery parameter - budget value (1-20,000) to scope Collections to
Filtering options:
companyIdquery parameter - Company ID (when not inferable from the calling key)accountIdquery parameter - Account ID. Required to retrieve Swag Collections.countriesquery parameter - comma-separated list of supported countries (defaultUS)typesquery parameter - comma-separated Collection types (swag,gifts,local experiences,custom)fieldsquery parameter - comma-separated field projection. Valid values:coverImage,thumbnails,createdBy,updatedAt,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:
- Swag Collections will not appear in the response unless
accountIdis supplied. - Returns
422(422_PBLC_001) when the suppliedcompanyIdoraccountIddoesn’t exist.
Permissions
- Requires:
collections: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_KEYAPI 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
Budget value
1 <= x <= 200001
Company ID
^[A-Za-z0-9]{8,}$"12345678"
Account ID
"a12bcd34"
List of supported countries
1["US"]List of collection types
1The types of the collection. Valid values are: swag, gifts, local experiences, custom.
swag, gifts, local experiences, custom ["swag"]List of additional fields to include in response objects
1The fields to return additionally in response. Valid values are: coverImage, thumbnails, createdBy, updatedAt, full.
coverImage, thumbnails, createdBy, updatedAt, full ["full"]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
Response
Successful response
Response containing collections.