Skip to main content
GET
/
v2
/
collections
Get collections
curl --request GET \
  --url https://api.snappy.com/public-api/v2/collections \
  --header 'X-Api-Key: <api-key>'
{
  "results": [
    {
      "id": "WS6bYz4cR8",
      "name": "Premium Tech Gifts",
      "types": [
        "gifts"
      ],
      "coverImage": "https://media.snappy.com/collections/tech-gifts-cover.jpg",
      "thumbnails": [
        "https://media.snappy.com/collections/tech-gifts-thumb1.jpg",
        "https://media.snappy.com/collections/tech-gifts-thumb2.jpg"
      ],
      "createdAt": "2024-01-15T10:30:00.000Z",
      "createdBy": "Snappy Team",
      "updatedAt": "2024-06-01T14:22:00.000Z"
    },
    {
      "id": "K9mP3xL7dN",
      "name": "Eco-Friendly Swag",
      "types": [
        "swag"
      ],
      "coverImage": "https://media.snappy.com/collections/eco-swag-cover.jpg",
      "thumbnails": [
        "https://media.snappy.com/collections/eco-swag-thumb1.jpg"
      ],
      "createdAt": "2024-02-20T09:15:00.000Z",
      "createdBy": "Snappy Team",
      "updatedAt": "2024-05-15T16:45:00.000Z"
    },
    {
      "id": "F8nQ2vB6jM",
      "name": "Local NYC Experiences",
      "types": [
        "local experiences"
      ],
      "coverImage": "https://media.snappy.com/collections/nyc-experiences-cover.jpg",
      "thumbnails": [
        "https://media.snappy.com/collections/nyc-exp-thumb1.jpg",
        "https://media.snappy.com/collections/nyc-exp-thumb2.jpg",
        "https://media.snappy.com/collections/nyc-exp-thumb3.jpg"
      ],
      "createdAt": "2024-03-10T11:00:00.000Z",
      "createdBy": "Snappy Team",
      "updatedAt": "2024-06-05T13:30:00.000Z"
    }
  ],
  "skip": 0,
  "limit": 100
}

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

​
budget
number
required

Budget value

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

1

​
companyId
string

Company ID

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

"12345678"

​
accountId
string

Account ID

Example:

"a12bcd34"

​
countries
string[]

List of supported countries

Minimum array length: 1
Example:
["US"]
​
types
enum<string>[]

List of collection types

Minimum array length: 1

The types of the collection. Valid values are: swag, gifts, local experiences, custom.

Available options:
swag,
gifts,
local experiences,
custom
Example:
["swag"]
​
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: coverImage, thumbnails, createdBy, updatedAt, full.

Available options:
coverImage,
thumbnails,
createdBy,
updatedAt,
full
Example:
["full"]
​
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

Response

Successful response

Response containing collections.

​
results
object[]
required

The fetched collections.

​
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

Last modified on April 30, 2026