API Documentation
Retailers
Cashback Offers
Coupon Offers
Promotion Offers
Transactions
Get retailers with active offers
Fetch all retailers with active offers.
curl --request GET \
--url https://api.onsleek.io/v1/retailers/ \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"id": "4812f869-dd9a-48e2-8dae-1658cb4569bf",
"name": "BestBuy",
"hostname": "bestbuy.com",
"url": "https://www.bestbuy.com",
"logo": "https://www.bestbuy.com/logo.png",
"cashbackOffers": [
{
"id": "9a8bcb3f-46db-4b01-b2c9-fe1693f99d7ff",
"featured": true,
"countries": [
"CA",
"US"
],
"cashbackPercentage": 0.14,
"maximumFixedCommissionFee": 50,
"description": "Get up to $75.00 cashback on all orders over $500.",
"category": "Electronics",
"termsAndExclusions": "Minimum purchase of $500.00 required."
}
],
"coupons": [
{
"code": "SAVE20",
"id": "77df23d1-dbf0-4b6c-ba09-5da4dbf484f1",
"description": "Use SAVE20 coupon code to get 20% off.",
"startDate": "2024-01-01T00:00:00",
"endDate": "2024-12-31T23:59:59"
}
],
"promotions": [
{
"id": "eebf1484-f3d2-42f4-a829-5e3f1dcfcecf",
"description": "Free shipping on all orders over $50.",
"startDate": "2024-01-01T00:00:00",
"endDate": "2024-12-31T23:59:59",
"deepLink": "https://www.bestbuy.com/promotion"
}
]
}
],
"cursor": "21171097-94a2-4ad9-bfe7-6bb84704dd83"
}
View all of Sleek’s retailers with active offers. This API is useful for populating your application with the latest retailer offers available to your users.
This API call uses your public API key and can be used on the client side.
How to use
This API should be called on your server side or client side to populate your application with the latest retailer offers available to your users.
Authorizations
Public Sleek API token.
Query Parameters
The ID of the next item that will be fetched. Format: UUID RFC 4122
Response
The unique identifier for the retailer. Format: UUID RFC 4122
The name of the retailer.
The hostname of the retailer's website.
The URL of the retailer's website.
The URL of the retailer's logo.
Cashback offers available for the retailer.
The ID of the retailer's cashback offer. Format: UUID RFC 4122
Indicates if the retailer's cashback offer is featured by Sleek for an outstanding deal.
The countries the retailer's cashback offer is available. Format: ISO 3166-1 alpha-2 code
The fixed cashback the retailer's offer. If null, the retailer offers a percentage.
The description of the fixed cashback offer.
The category of the cashback offer.
The terms and exclusions of the cashback offer.
The percentage of cashback the retailer offers. In decimal form.
Coupons available for the retailer.
The coupon code value.
The unique identifier for the coupon. Format: UUID RFC 4122
The description of the coupon.
The date and time when the coupon becomes active. Format: ISO 8601
The date and time when the coupon expires. Format: ISO 8601
Promotions available for the retailer.
The unique identifier for the promotion. Format: UUID RFC 4122
The description of the promotion.
The date and time when the promotion becomes active. Format: ISO 8601
The date and time when the promotion expires. Format: ISO 8601
The deep link URL for the promotion.
The ID of the next item in the list. Defined if there are more items to fetch. Pass this as the cursor
query parameter to fetch the next page. Format: UUID RFC 4122
curl --request GET \
--url https://api.onsleek.io/v1/retailers/ \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"id": "4812f869-dd9a-48e2-8dae-1658cb4569bf",
"name": "BestBuy",
"hostname": "bestbuy.com",
"url": "https://www.bestbuy.com",
"logo": "https://www.bestbuy.com/logo.png",
"cashbackOffers": [
{
"id": "9a8bcb3f-46db-4b01-b2c9-fe1693f99d7ff",
"featured": true,
"countries": [
"CA",
"US"
],
"cashbackPercentage": 0.14,
"maximumFixedCommissionFee": 50,
"description": "Get up to $75.00 cashback on all orders over $500.",
"category": "Electronics",
"termsAndExclusions": "Minimum purchase of $500.00 required."
}
],
"coupons": [
{
"code": "SAVE20",
"id": "77df23d1-dbf0-4b6c-ba09-5da4dbf484f1",
"description": "Use SAVE20 coupon code to get 20% off.",
"startDate": "2024-01-01T00:00:00",
"endDate": "2024-12-31T23:59:59"
}
],
"promotions": [
{
"id": "eebf1484-f3d2-42f4-a829-5e3f1dcfcecf",
"description": "Free shipping on all orders over $50.",
"startDate": "2024-01-01T00:00:00",
"endDate": "2024-12-31T23:59:59",
"deepLink": "https://www.bestbuy.com/promotion"
}
]
}
],
"cursor": "21171097-94a2-4ad9-bfe7-6bb84704dd83"
}