--- title: "Get Offers for Publishers" method: GET path: "/v2/publishers/offers" tags: ["Server-Side"] --- # Get Offers for Publishers `GET /v2/publishers/offers` Returns a list of offers that are available for all users. Note that this is not customized for any user. ## Query parameters - `limit` integer — Limit the number of results to X. - `skip` integer — Skips the first X number of results. - `countries` string[] — Filter by specific countries using ISO country codes. - `offer_ids` string — Filter by specific offers. Accepts a list of comma separated offer IDs. - `pay_min` string — Filter by offers above a minimum payout. Values are in USD. - `min_epc` string — Filter by offers above a minimum EPC. Values are in USD. - `categories` string — Filter by offers in certain categories. Accepts a comma separated list of category IDs. - `platforms` string — Filter by specific platforms. Accepts a list of comma separated platforms from desktop, smartphone, tablet. - `order_by` 'payout' | 'epc' | 'id' — Order results by either payout, epc, or id(offer id) in descending order. payout is calculated as the maximum payout from the offer's events. Default is epc. ## Response `200` OK - object - `data` PublisherOffersV2 - `offers` PublisherOfferV2[], required - `id` integer, required - `name` string, required — Internal offer name, not to be displayed to end-users. - `anchor` string, required — Offer title as shown to the end-user. - `country_stats` PublisherOfferV2CountryStats[], required — Mobile and desktop ranks that indicate how well the offer performs compared to other offers within the same country. If API options are provided that filter the results, such as categories or platform, the ranks are calculated within the filtered result set. Note: the ranking algorithm is subject to change in the future. Please allow for gaps in the numeric ranks. - `country_code` string, required - `mobile_rank` integer, required - `desktop_rank` integer, required - `description` string, required — Offer description. - `requirements` string, required — Offer requirements. The user must complete these requirements in order to convert. - `things_to_know` string[], required — List of key points the user should be aware of regarding the offer such as prerequisites or limitations. - `disclaimer` string, required — Detailed disclaimer outlining additional conditions, sponsor affiliations, and terms for eligibility. It may include placeholders for dynamic content such as currency name or site name.. - `pending_time` integer, required — Time in minutes that a reward will be held from the user following completion. - `translations` object, required — Available translations for the offer anchor, description and requirements. - `device_targeting` PublisherOfferV2DeviceTargeting, required - `browsers` PublisherOfferV2DeviceTarget[], required — If present, the offer requires one of the specified browsers. Possible values are: chrome, firefox, safari, edge, internet explorer, chrome mobile, mobile safari (More values may be added in the future) - `name` string, required - `min_version` string — Minimum version number of the operating system above. If there is no minimum version requirement, this value will be null. - `max_version` string — Maximum version number of the operating system above. If there is no minimum version requirement, this value will be null. - `operating_systems` PublisherOfferV2DeviceTarget[], required — If present, the offer requires one of the specified operating systems. Possible values are: windows, mac os, ios, android (More values may be added in the future) - `name` string, required - `min_version` string — Minimum version number of the operating system above. If there is no minimum version requirement, this value will be null. - `max_version` string — Maximum version number of the operating system above. If there is no minimum version requirement, this value will be null. - `devices` PublisherOfferV2DeviceTarget[], required — If present, the offer requires one of the specified devices. Possible values are: iphone, ipad (More values may be added in the future) - `name` string, required - `min_version` string — Minimum version number of the operating system above. If there is no minimum version requirement, this value will be null. - `max_version` string — Maximum version number of the operating system above. If there is no minimum version requirement, this value will be null. - `platforms` PublisherOfferV2DeviceTarget[], required — If present, the offer requires one of the specified platforms. Possible values are: smartphone, tablet, desktop (More values may be added in the future) - `name` string, required - `min_version` string — Minimum version number of the operating system above. If there is no minimum version requirement, this value will be null. - `max_version` string — Maximum version number of the operating system above. If there is no minimum version requirement, this value will be null. - `geo_targeting` PublisherOfferV2GeoTargeting, required - `countries` PublisherOfferV2GeoTarget[], required — uses country_code - `country_code` string — The two-letter country codes this offer is available to. If no countries are provided, all countries are permitted. Use GB for the UK. - `geoname_id` integer — The states/regions/city that the offer is limited to, provided by the geoname ID. You may find a searchable and downloadable database of geoname IDs from https://www.geonames.org/ - `name` string — The name of the state/region/city as provided by Geonames. - `code` string — The postal code the offer is limited to. - `states` PublisherOfferV2GeoTarget[], required — uses geoname_id & name - `country_code` string — The two-letter country codes this offer is available to. If no countries are provided, all countries are permitted. Use GB for the UK. - `geoname_id` integer — The states/regions/city that the offer is limited to, provided by the geoname ID. You may find a searchable and downloadable database of geoname IDs from https://www.geonames.org/ - `name` string — The name of the state/region/city as provided by Geonames. - `code` string — The postal code the offer is limited to. - `cities` PublisherOfferV2GeoTarget[], required — uses geoname_id & name - `country_code` string — The two-letter country codes this offer is available to. If no countries are provided, all countries are permitted. Use GB for the UK. - `geoname_id` integer — The states/regions/city that the offer is limited to, provided by the geoname ID. You may find a searchable and downloadable database of geoname IDs from https://www.geonames.org/ - `name` string — The name of the state/region/city as provided by Geonames. - `code` string — The postal code the offer is limited to. - `postal_codes` PublisherOfferV2GeoTarget[], required — uses code - `country_code` string — The two-letter country codes this offer is available to. If no countries are provided, all countries are permitted. Use GB for the UK. - `geoname_id` integer — The states/regions/city that the offer is limited to, provided by the geoname ID. You may find a searchable and downloadable database of geoname IDs from https://www.geonames.org/ - `name` string — The name of the state/region/city as provided by Geonames. - `code` string — The postal code the offer is limited to. - `icon` string, required — Deprecated: Use creatives.icon instead. This field will be removed in a future version. - `creatives` OfferV2Creatives — Creative assets for the offer. - `icon` string — Deprecated: Use creatives.icon instead. This field will be removed in a future version. - `images` object — Creative assets for the offer in different sizes. - `epc` string, required — Network-wide EPCs - `categories` string[], required — An array of offer categories - `events` PublisherOfferV2Event[], required — An array of offer events. - `id` string, required — UUID of the event - `hash` string — Unique offer event hash. - `name` string, required — Event title - `payout_type` 'flat' | 'dynamic', required — One of "flat" or "dynamic". Flat payouts don't change. Dynamic payouts vary. Only 'flat' events are served at the moment. - `payout` string, required — The dollar amount. - `is_cpc` boolean, required — Boolean. Indicates if the offer event is CPC (cost-per-click). - `multiple_conversions_allowed` boolean, required — Boolean. Indicates if the offer event allows multiple conversions for a single user (IP), according to the rules specified in "multiple_conversions_rules". - `points` string, required — It is 0 if the event is not payable. - `promotional_points` string — Points if there is an ongoing promotion - `multiple_conversions_rules` PublisherOfferV2EventMultipleConversionRules - `rule_type` 'unlimited' | 'interval', required - `x_conversions` integer, required - `every_y_seconds` integer, required - `type_id` integer, required — ID used to identify the event type. See all available Event IDs here: https://developer.bitlabs.ai/docs/offer-api#event-type-ids - `translations` object, required — Available translations for the event name. - `ttc_minutes` integer, required — Time to complete in minutes (if applicable). - `click_url` string, required — Tracking link. The s1 parameter should include the ID of the user accessing the offer. The ID can be any string up to 255 characters long. s2,s3,s4 and s5 subids are available. - `support_url` string, required — The URL the user can access to get support in case they are not rewarded. The s1 parameter is required (see click_url above for info.) Note that most offers require waiting at least one hour after clicking an offer to be able to contact support. - `preview_url` string, required — Preview of the offer's landing page. - `app_metadata` OfferV2AppMetadata, required - `app_id` string — The app ID - `categories` string[], required — The categories the app belongs to - `screenshot_urls` string[], required — URLs to screenshots of the app - `video_urls` string[], required — URLs to videos of the app - `is_game` boolean, required — Boolean. Indicates if the offer is a game. - `product_id` string, required — A unique string shared between offers which belong to same product, e.g. same mobile app. - `product_name` string, required — The offer's product name. - `is_sensitive` boolean, required — Indicates if the offer is sensitive, e.g. contains adult content. - `advertiser_id` integer, required — The advertiser's ID. This is used to identify the advertiser in the system. - `total_points` integer, required — Total points awarded for completing the offer. - `total_promotional_points` integer, required — Total promotional points awarded for completing the offer. - `session_hours` integer, required — The maximum number of hours that a user has to complete the offer after clicking it. - `demographic_targeting` PublisherOfferV2DemographicTargeting, required - `age` PublisherOfferV2DemographicAge - `exclude` boolean — Whether to exclude the specified age groups from the targeting. - `unknown_allowed` boolean — Whether to allow users with unknown or unspecified age. - `options` PublisherOfferV2DemographicAgeOption[] - `min_age` integer, nullable — The minimum age for the range (inclusive). - `max_age` integer, nullable — The maximum age for the range (inclusive). - `gender` PublisherOfferV2DemographicGender - `exclude` boolean — Whether to exclude the specified gender groups from the targeting. - `unknown_allowed` boolean — Whether to allow users with unknown or unspecified gender. - `options` string[] — An array of strings specifying the genders. - `lowest_cap_left` integer, nullable — The lowest cap left for the offer, indicating remaining capacity. - `arpu_goals` OfferV2ArpuGoal[] — ARPU (Average Revenue Per User) goals for the offer, specifying daily targets in dollars. - `day` integer, required — The day number for the ARPU goal. - `goal` string, required — The goal amount in dollars for the specified day. --- [API](https://skmtc.net/bitlabs/apis/bitlabs-client-api.md) · [All operations](https://skmtc.net/bitlabs/apis/bitlabs-client-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bitlabs/bitlabs-client-api/revisions/99209a6285bf/schema)