Skip to main content
GET
/
v1
/
deals
/
promotions
/
{id}
Get promotion by ID
curl --request GET \
  --url https://api.onsleek.ai/v1/deals/promotions/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "ce0839f8-b522-41a4-9c09-5f3e510fb2d9",
  "startDate": "2024-01-01T00:00:00.000Z",
  "endDate": "2024-12-31T23:59:59.999Z",
  "description": "Free shipping on all orders over $50.",
  "retailerId": "4f9df53d-16dc-4630-8603-8d14ec40fcfe",
  "url": "https://www.bestbuy.com",
  "name": "BestBuy",
  "hostname": "www.bestbuy.com",
  "deepLink": "https://www.bestbuy.com/promotion",
  "updatedAt": "2024-01-01T12:00:00.000Z",
  "logo": "https://www.bestbuy.com/logo.png"
}

Authorizations

​
Authorization
string
header
required

API key for accessing the Sleek API.

Path Parameters

​
id
string
required

The ID of the promotion to fetch.

Response

200 - application/json

Promotion by id.

​
id
string
required

The unique identifier for the promotion. Format: UUID RFC 4122

Example:

"ce0839f8-b522-41a4-9c09-5f3e510fb2d9"

​
startDate
string
required

The date and time when the promotion becomes active. Format: ISO 8601

Example:

"2024-01-01T00:00:00.000Z"

​
endDate
string
required

The date and time when the promotion expires. Format: ISO 8601

Example:

"2024-12-31T23:59:59.999Z"

​
description
string
required

The description of the promotion.

Example:

"Free shipping on all orders over $50."

​
retailerId
string
required

The ID of the retailer associated with the promotion offer. Format: UUID RFC 4122

Example:

"4f9df53d-16dc-4630-8603-8d14ec40fcfe"

​
url
string
required

The URL of the retailer's website where the promotion can be used.

Example:

"https://www.bestbuy.com"

​
name
string
required

The name of the retailer associated with the promotion.

Example:

"BestBuy"

​
hostname
string
required

The hostname of the retailer's website.

Example:

"www.bestbuy.com"

​
deepLink
string
required

The deep link URL for the promotion.

Example:

"https://www.bestbuy.com/promotion"

​
updatedAt
string
required

The date and time when the promotion was last updated. Format: ISO 8601

Example:

"2024-01-01T12:00:00.000Z"

The URL of the retailer's logo associated with the promotion.

Example:

"https://www.bestbuy.com/logo.png"