Get gift by ID
Use this endpoint to retrieve a specific Gift by its ID. Useful for tracking delivery status, retrieving final gift cost, or reviewing the recipient and campaign context.
Required fields:
giftId- the Gift identifier, passed as a path parameter
Optional parameters:
companyIdquery parameter - Company ID (when not inferable from the calling key)expand- comma-separated objects to inline (finalCost,deliveryDetails,estimatedCost,recipient,orders,customization)Request-Sourceheader - source of the request
Please note:
- Use
expand=ordersto retrieve the full order history including cancelled orders. - Use
expand=finalCostto retrieve the actual cost after the gift has been claimed.
Permissions
- Requires:
gifts:read:maskedorgifts:read:unmasked
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"
Path Parameters
Gift ID
^[A-Za-z0-9]{8,}$"abc123de"
Query Parameters
Company ID
^[A-Za-z0-9]{8,}$"12345678"
The fields that can be returned for the gift. comma-separated format without whitespace in between. valid values are: finalCost, deliveryDetails, estimatedCost, recipient, customization, orders.
1Fields that can be returned for the gift
finalCost, deliveryDetails, estimatedCost, recipient, orders, customization Response
Ok
The Gift object.
The gift identifier
The company id
"12345678"
The campaign identifier
The status of the gift.
The budget plan of the gift. This field is deprecated, use "customization.giftProperties.budget" instead.
A Thank You Note sent by the end client.
The estimated cost of the gift including estimated tax and fee.
{
"budget": 100,
"estimatedFee": 2,
"estimatedTax": 7,
"estimatedTotalCost": 109
}When the gift will be expired. Date Format: YYYY-MM-DDThh:mm:ss.sZ. This field is deprecated, use "customization.giftProperties.expiration" instead.
"2022-12-06T09:50:38.536Z"
When the gift was originally created. Date Format: YYYY-MM-DDThh:mm:ss.sZ. e.g. 2022-12-06T09:50:38.536Z
The link used to redeem the gift.
The success of the gift creation
The Delivery Details object.
The final cost of the gift including tax and fee.
{
"cost": 100,
"finalFee": 2,
"finalTax": 7,
"totalFinalCost": 109
}The gift recipient object.
{
"firstname": "John",
"lastname": "Doe",
"externalId": "1234567890",
"phone": "+1234567890",
"email": "example@domain.com",
"key": "abc123"
}Complete gift customization configuration