API Integration (Advanced)
Get Offers API
Retrieve your wall's offer catalog, including rewards, targeting, caps and creatives, for inventory ingestion and user-facing integrations.
Overview
Get Offers returns a static catalog for a publisher wall. Authenticate with your publisher account API key and supply the wall ID. Omitting limit returns all matching offers; explicit limit and offset enable pagination. Cache responses and keep inventory current within the rate limit.
Server-side filters include country, platform, category, tags, event crediting timing, sequential events and capping. State and dayparting restrictions are returned for your integration to apply. This endpoint does not evaluate individual user eligibility. Use Get Personalized for a user-specific offer list.
How It Works
Send a GET request with the wall ID and publisher account API key.
Read the returned catalog and any pagination metadata.
Apply relevant targeting and timing restrictions, and use Get Personalized for user-specific eligibility.
Set the user’s ID in the
sid2parameter of the selected offer’sclick_url_basebefore serving it.Process conversion notifications through your configured postback.
Use Cases
Render a publisher’s full offerwall with the complete available offer catalog.
Cache and serve offer listings efficiently without making a call on every page load.
Inspect current cap snapshots when refreshing inventory. Capacity can change after the response; a snapshot does not reserve capacity or establish user eligibility.
API Key
This call requires your Account API key, which can be retrieved in the Publisher Portal under My Account > Account API Key.
Note
If you're looking for the legacy All Offers API documentation, you can find it here.
Share feedback on this documentation
