BYBE Offers API
An offer is created and funded by a manufacturer (brand).
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/bybe-offers-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: BYBE Offers API
version: v1
description: "\n Welcome to the BYBE API, V1.\n\n You can use this API to access our records of manufacturers,\n rebate offers, and products,\n as well as to validate redemptions for transactions and disburse payouts.\n\n Each route is documented below via the OpenAPI specification.\n Authorization details can be entered using the `Authorize` button on the right.\n "
servers:
- url: https://api.bybe.io
description: Base URL declared by the provider in apis.yml (roadmap#122).
tags:
- name: Offers
description: An offer is created and funded by a manufacturer (brand).
paths:
/v1/offers:
get:
summary: list offers
tags:
- Offers
security:
- basic_auth: []
parameters:
- name: show_stores
in: query
required: false
description: Defaults to true. When false, stores associated with offers are omitted from the response.
schema:
type: boolean
- name: show_clips
in: query
required: false
description: Requires consumer_retailer_identifier. When true, includes clip information for each offer indicating whether it has been clipped by the specified consumer.
schema:
type: boolean
- name: show_details
in: query
required: false
description: Defaults to false. When true, includes additional store details in the response.
schema:
type: boolean
- name: prelive
in: query
required: false
description: Defaults to false. When true, includes offers that are not yet live. Client applications should ensure pre-live offers are hidden from end users.
schema:
type: boolean
- name: state
in: query
schema:
$ref: '#/components/schemas/state_string_enum'
required: false
description: By default offers from all states are returned. When a state is specified, only offers available in that state are returned.
- name: consumer_retailer_identifier
in: query
required: false
description: Adds consumer-specific information to the response, such as whether the offers have been clipped by the specified consumer as well as how many redemptions remain for each offer based on the consumer's previous redemptions.
schema:
type: string
responses:
'200':
description: successfully list offers
content:
application/json:
examples:
unfiltered list of offers:
value:
offers:
- id: 36642025
name: 1Super Saver Special
image_url: thing.jpg
clip_limit: 5
clips_remaining: 5
budget_limit_cents: 5000
budget_limit_currency: USD
budget_remaining_cents: 4000
budget_remaining_currency: USD
discount_cents: 500
discount_currency: USD
conditions: Buy 2 get 1 back
details: Offer details
start_date: '2017-10-27'
end_date: '2026-06-27'
per_consumer_limit: 2
daily_per_consumer_limit: null
redemptions_available: 4
redemptions_remaining: 2
redemptions_used: 2
offer_type: discount
created_at: '2026-06-17T13:55:38.857Z'
updated_at: '2026-06-17T13:55:38.857Z'
featured: false
vibrant_colors: null
image_content_height: null
required_products:
- quantity: 2
product:
retailer_identifier: 123ABC
name: 12 Pack of Beer
upcs:
- '767676767676'
image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png
product_type:
name: Beer
products:
- retailer_identifier: 123ABC
name: 12 Pack of Beer
upcs:
- '767676767676'
image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png
product_type:
name: Beer
- retailer_identifier: null
name: Jug of Vodka
upcs:
- '434363463463'
image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png
product_type:
name: Cider
- retailer_identifier: 123ABC
name: Soft Apple Cider
upcs:
- '123123123123'
- '989898989898'
image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png
product_type:
name: Cider
states:
- abbreviation: OH
name: Ohio
- abbreviation: IL
name: Illinois
stores:
- retailer_identifier: 0000Valid
- retailer_identifier: CBUS
- id: 373731297
name: Buy 2x and Y
image_url: thing.jpg
clip_limit: 5
clips_remaining: 5
budget_limit_cents: 5000
budget_limit_currency: USD
budget_remaining_cents: 5000
budget_remaining_currency: USD
discount_cents: 100
discount_currency: USD
conditions: Buy 2x and y get z back
details: Offer details
start_date: '2017-10-27'
end_date: '2026-06-27'
per_consumer_limit: 2
daily_per_consumer_limit: null
redemptions_available: 4
redemptions_remaining: 4
redemptions_used: 0
offer_type: discount
created_at: '2026-06-17T13:55:38.857Z'
updated_at: '2026-06-17T13:55:38.857Z'
featured: false
vibrant_colors: null
image_content_height: null
required_products:
- quantity: 2
product:
retailer_identifier: 123ABC
name: 12 Pack of Beer
upcs:
- '767676767676'
image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png
product_type:
name: Beer
products:
- retailer_identifier: 123ABC
name: 12 Pack of Beer
upcs:
- '767676767676'
image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png
product_type:
name: Beer
- quantity: 1
product:
retailer_identifier: 123ABC
name: Soft Apple Cider
upcs:
- '123123123123'
- '989898989898'
image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png
product_type:
name: Cider
products:
- retailer_identifier: 123ABC
name: Soft Apple Cider
upcs:
- '123123123123'
- '989898989898'
image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png
product_type:
name: Cider
states:
- abbreviation: OH
name: Ohio
stores:
- retailer_identifier: 0000Valid
- retailer_identifier: CBUS
- id: 567695903
name: Buy w and 2x
image_url: thing.jpg
clip_limit: 5
clips_remaining: 5
budget_limit_cents: 5000
budget_limit_currency: USD
budget_remaining_cents: 5000
budget_remaining_currency: USD
discount_cents: 300
discount_currency: USD
conditions: Buy w and x get z back
details: Offer details
start_date: '2017-10-27'
end_date: '2026-06-27'
per_consumer_limit: 2
daily_per_consumer_limit: null
redemptions_available: 4
redemptions_remaining: 4
redemptions_used: 0
offer_type: discount
created_at: '2026-06-17T13:55:38.857Z'
updated_at: '2026-06-17T13:55:38.857Z'
featured: false
vibrant_colors: null
image_content_height: null
required_products:
- quantity: 1
product:
retailer_identifier: null
name: Jug of Vodka
upcs:
- '434363463463'
image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png
product_type:
name: Cider
products:
- retailer_identifier: null
name: Jug of Vodka
upcs:
- '434363463463'
image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png
product_type:
name: Cider
- quantity: 2
product:
retailer_identifier: 123ABC
name: 12 Pack of Beer
upcs:
- '767676767676'
image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png
product_type:
name: Beer
products:
- retailer_identifier: 123ABC
name: 12 Pack of Beer
upcs:
- '767676767676'
image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png
product_type:
name: Beer
states:
- abbreviation: OH
name: Ohio
stores:
- retailer_identifier: 0000Valid
- retailer_identifier: CBUS
- id: 980190962
name: Holiday sale on spirits
image_url: thing.jpg
clip_limit: 5
clips_remaining: -3
budget_limit_cents: 2000
budget_limit_currency: USD
budget_remaining_cents: 1700
budget_remaining_currency: USD
discount_cents: 300
discount_currency: USD
conditions: Offer open to residents of KY. Must be 21 years of age.
details: Offer details
start_date: '2017-10-27'
end_date: '2026-07-17'
per_consumer_limit: 1
daily_per_consumer_limit: null
redemptions_available: 10
redemptions_remaining: 9
redemptions_used: 1
offer_type: discount
created_at: '2026-06-17T13:55:38.857Z'
updated_at: '2026-06-17T13:55:38.857Z'
featured: false
vibrant_colors: null
image_content_height: null
required_products:
- quantity: 1
product:
retailer_identifier: 123ABC
name: Hard Apple Cider
upcs:
- '123123123123'
image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png
product_type:
name: Cider
products:
- retailer_identifier: 123ABC
name: Hard Apple Cider
upcs:
- '123123123123'
image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png
product_type:
name: Cider
states:
- abbreviation: OH
name: Ohio
- abbreviation: CA
name: California
stores:
- retailer_identifier: LA
- retailer_identifier: 0000Valid
- retailer_identifier: CBUS
- id: 298486374
name: Holiday sale on booze
image_url: thing.jpg
clip_limit: 5
clips_remaining: 5
budget_limit_cents: 2000
budget_limit_currency: USD
budget_remaining_cents: 2000
budget_remaining_currency: USD
discount_cents: 300
discount_currency: USD
conditions: Offer open to residents of OH. Must be 21 years of age.
details: Offer details
start_date: '2017-10-27'
end_date: '2026-07-17'
per_consumer_limit: 1
daily_per_consumer_limit: null
redemptions_available: 10
redemptions_remaining: 10
redemptions_used: 0
offer_type: discount
created_at: '2026-06-10T13:55:38.000Z'
updated_at: '2026-06-10T13:55:38.000Z'
featured: false
vibrant_colors: null
image_content_height: null
required_products:
- quantity: 1
product:
retailer_identifier: 123ABC
name: Hard Apple Cider
upcs:
- '123123123123'
image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png
product_type:
name: Cider
products:
- retailer_identifier: 123ABC
name: Hard Apple Cider
upcs:
- '123123123123'
image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png
product_type:
name: Cider
- quantity: 1
product:
retailer_identifier: 123ABC
name: Hard Apple Cider
upcs:
- '123123123123'
image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png
product_type:
name: Cider
products:
- retailer_identifier: 123ABC
name: Hard Apple Cider
upcs:
- '123123123123'
image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png
product_type:
name: Cider
- retailer_identifier: 123ABC
name: Soft Apple Cider
upcs:
- '123123123123'
- '989898989898'
image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png
product_type:
name: Cider
states:
- abbreviation: OH
name: Ohio
stores:
- retailer_identifier: 0000Valid
- retailer_identifier: CBUS
meta:
count: 5
filter offers by state:
value:
offers:
- id: 36642025
name: 1Super Saver Special
image_url: thing.jpg
clip_limit: 5
clips_remaining: 5
budget_limit_cents: 5000
budget_limit_currency: USD
budget_remaining_cents: 4000
budget_remaining_currency: USD
discount_cents: 500
discount_currency: USD
conditions: Buy 2 get 1 back
details: Offer details
start_date: '2017-10-27'
end_date: '2026-06-27'
per_consumer_limit: 2
daily_per_consumer_limit: null
redemptions_available: 4
redemptions_remaining: 2
redemptions_used: 2
offer_type: discount
created_at: '2026-06-17T13:55:38.857Z'
updated_at: '2026-06-17T13:55:38.857Z'
featured: false
vibrant_colors: null
image_content_height: null
required_products:
- quantity: 2
product:
retailer_identifier: 123ABC
name: 12 Pack of Beer
upcs:
- '767676767676'
image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png
product_type:
name: Beer
products:
- retailer_identifier: 123ABC
name: 12 Pack of Beer
upcs:
- '767676767676'
image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png
product_type:
name: Beer
- retailer_identifier: null
name: Jug of Vodka
upcs:
- '434363463463'
image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png
product_type:
name: Cider
- retailer_identifier: 123ABC
name: Soft Apple Cider
upcs:
- '123123123123'
- '989898989898'
image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png
product_type:
name: Cider
states:
- abbreviation: OH
name: Ohio
- abbreviation: IL
name: Illinois
stores:
- retailer_identifier: 0000Valid
- retailer_identifier: CBUS
- id: 373731297
name: Buy 2x and Y
image_url: thing.jpg
clip_limit: 5
clips_remaining: 5
budget_limit_cents: 5000
budget_limit_currency: USD
budget_remaining_cents: 5000
budget_remaining_currency: USD
discount_cents: 100
discount_currency: USD
conditions: Buy 2x and y get z back
details: Offer details
start_date: '2017-10-27'
end_date: '2026-06-27'
per_consumer_limit: 2
daily_per_consumer_limit: null
redemptions_available: 4
redemptions_remaining: 4
redemptions_used: 0
offer_type: discount
created_at: '2026-06-17T13:55:38.857Z'
updated_at: '2026-06-17T13:55:38.857Z'
featured: false
vibrant_colors: null
image_content_height: null
required_products:
- quantity: 2
product:
retailer_identifier: 123ABC
name: 12 Pack of Beer
upcs:
- '767676767676'
image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png
product_type:
name: Beer
products:
- retailer_identifier: 123ABC
name: 12 Pack of Beer
upcs:
- '767676767676'
image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png
product_type:
name: Beer
- quantity: 1
product:
retailer_identifier: 123ABC
name: Soft Apple Cider
upcs:
- '123123123123'
- '989898989898'
image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png
product_type:
name: Cider
products:
- retailer_identifier: 123ABC
name: Soft Apple Cider
upcs:
- '123123123123'
- '989898989898'
image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png
product_type:
name: Cider
states:
- abbreviation: OH
name: Ohio
stores:
- retailer_identifier: 0000Valid
- retailer_identifier: CBUS
- id: 567695903
name: Buy w and 2x
image_url: thing.jpg
clip_limit: 5
clips_remaining: 5
budget_limit_cents: 5000
budget_limit_currency: USD
budget_remaining_cents: 5000
budget_remaining_currency: USD
discount_cents: 300
discount_currency: USD
conditions: Buy w and x get z back
details: Offer details
start_date: '2017-10-27'
end_date: '2026-06-27'
per_consumer_limit: 2
daily_per_consumer_limit: null
redemptions_available: 4
redemptions_remaining: 4
redemptions_used: 0
offer_type: discount
created_at: '2026-06-17T13:55:38.857Z'
updated_at: '2026-06-17T13:55:38.857Z'
featured: false
vibrant_colors: null
image_content_height: null
required_products:
- quantity: 1
product:
retailer_identifier: null
name: Jug of Vodka
upcs:
- '434363463463'
image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png
product_type:
name: Cider
products:
- retailer_identifier: null
name: Jug of Vodka
upcs:
- '434363463463'
image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png
product_type:
name: Cider
- quantity: 2
product:
retailer_identifier: 123ABC
name: 12 Pack of Beer
upcs:
- '767676767676'
image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png
product_type:
name: Beer
products:
- retailer_identifier: 123ABC
name: 12 Pack of Beer
upcs:
- '767676767676'
image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png
product_type:
name: Beer
states:
- abbreviation: OH
name: Ohio
stores:
- retailer_identifier: 0000Valid
- retailer_identifier: CBUS
- id: 980190962
name: Holiday sale on spirits
image_url: thing.jpg
clip_limit: 5
clips_remaining: -3
budget_limit_cents: 2000
budget_limit_currency: USD
budget_remaining_cents: 1700
budget_remaining_currency: USD
discount_cents: 300
discount_currency: USD
conditions: Offer open to residents of KY. Must be 21 years of age.
details: Offer details
start_date: '2017-10-27'
end_date: '2026-07-17'
per_consumer_limit: 1
daily_per_consumer_limit: null
redemptions_available: 10
redemptions_remaining: 9
redemptions_used: 1
offer_type: discount
created_at: '2026-06-17T13:55:38.857Z'
updated_at: '2026-06-17T13:55:38.857Z'
featured: false
vibrant_colors: null
image_content_height: null
required_products:
- quantity: 1
product:
retailer_identifier: 123ABC
name: Hard Apple Cider
upcs:
- '123123123123'
image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png
product_type:
name: Cider
products:
- retailer_identifier: 123ABC
name: Hard Apple Cider
upcs:
- '123123123123'
image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png
product_type:
name: Cider
states:
- abbreviation: OH
name: Ohio
- abbreviation: CA
name: California
stores:
- retailer_identifier: 0000Valid
- retailer_identifier: CBUS
- id: 298486374
name: Holiday sale on booze
image_url: thing.jpg
clip_limit: 5
clips_remaining: 5
budget_limit_cents: 2000
budget_limit_currency: USD
budget_remaining_cents: 2000
budget_remaining_currency: USD
discount_cents: 300
discount_currency: USD
conditions: Offer open to residents of OH. Must be 21 years of age.
details: Offer details
start_date: '2017-10-27'
end_date: '2026-07-17'
per_consumer_limit: 1
daily_per_consumer_limit: null
redemptions_available: 10
redemptions_remaining: 10
redemptions_used: 0
offer_type: discount
created_at: '2026-06-10T13:55:38.000Z'
updated_at: '2026-06-10T13:55:38.000Z'
featured: false
vibrant_colors: null
image_content_height: null
required_products:
- quantity: 1
product:
retailer_identifier: 123ABC
name: Hard Apple Cider
upcs:
- '123123123123'
image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png
product_type:
name: Cider
products:
- retailer_identifier: 123ABC
name: Hard Apple Cider
upcs:
- '123123123123'
image_url: https://s3.amazonaws.com/bybe-product-images/coppola-chardonnay.png
product_type:
name: Cider
- quantity: 1
product:
retailer_identifier: 123ABC
name: Hard Apple Cider
upcs:
- '123123123123'
# --- truncated at 32 KB (85 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/bybe/refs/heads/main/openapi/bybe-offers-api-openapi.yml