Get coupon offers

curl --request GET \
  --url https://api.onsleek.ai/v1/deals/coupons \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "ea0efd78-2c3c-4efd-9e92-1ab676ee304b",
      "code": "SAVE20",
      "startDate": "2024-01-01T00:00:00.000Z",
      "endDate": "2024-12-31T23:59:59.999Z",
      "description": "Use SAVE20 coupon code to get 20% off.",
      "retailerId": "4f9df53d-16dc-4630-8603-8d14ec40fcfe",
      "url": "https://www.bestbuy.com",
      "name": "BestBuy",
      "hostname": "www.bestbuy.com",
      "updatedAt": "2024-01-01T12:00:00.000Z",
      "logo": "https://www.bestbuy.com/logo.png"
    }
  ],
  "cursor": "<string>"
}

GET

deals

coupons

Get coupon offers

curl --request GET \
  --url https://api.onsleek.ai/v1/deals/coupons \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "ea0efd78-2c3c-4efd-9e92-1ab676ee304b",
      "code": "SAVE20",
      "startDate": "2024-01-01T00:00:00.000Z",
      "endDate": "2024-12-31T23:59:59.999Z",
      "description": "Use SAVE20 coupon code to get 20% off.",
      "retailerId": "4f9df53d-16dc-4630-8603-8d14ec40fcfe",
      "url": "https://www.bestbuy.com",
      "name": "BestBuy",
      "hostname": "www.bestbuy.com",
      "updatedAt": "2024-01-01T12:00:00.000Z",
      "logo": "https://www.bestbuy.com/logo.png"
    }
  ],
  "cursor": "<string>"
}

Authorizations

Authorization

string

header

required

API key for accessing the Sleek API.

Query Parameters

cursor

string

The ID of the next item that will be fetched. Format: UUID RFC 4122

hostname

string

The hostname of the retailer to search for.

Response

200 - application/json

List of coupon offers.

data

object[]

required

Show child attributes

data.id

string

required

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

Example:

"ea0efd78-2c3c-4efd-9e92-1ab676ee304b"

data.code

string

required

The coupon code value.

Example:

"SAVE20"

data.startDate

string

required

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

Example:

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

data.endDate

string

required

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

Example:

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

data.description

string

required

The description of the coupon.

Example:

"Use SAVE20 coupon code to get 20% off."

data.retailerId

string

required

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

Example:

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

data.url

string

required

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

Example:

"https://www.bestbuy.com"

data.name

string

required

The name of the retailer associated with the coupon.

Example:

"BestBuy"

data.hostname

string

required

The hostname of the retailer's website.

Example:

"www.bestbuy.com"

data.updatedAt

string

required

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

Example:

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

data.logo

string

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

Example:

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

cursor

string

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

Activate coupon offer Get coupon by ID

⌘I

API Documentation

Endpoints

Get coupon offers

Authorizations

Query Parameters

Response