Skip to main content
GET
cURL
Returns the partner offer cards to show for the authenticated brand, for one offer type. For example, post-purchase offers appear on a store’s order confirmation page.
cURL
Authenticate with the API key in the playground, or send an OAuth access token in Authorization. See Authentication.

Which platform to send

Every call names the platform that displays the offers. Views and orders from these offers are credited to that platform.
  • OAuth: an access token authorized with your platform ID already carries it. You don’t need the header. If you send it anyway, it must match.
  • API key: send your platform ID in X-Platform-Id.
  • A brand showing offers on its own site, with no tech partner: send Branduo’s platform ID, 84605dab-79fd-4b37-857c-bfd59bd9c436.

Query parameters

string
required
The offer type. Today the only value is post-purchase: offers shown after checkout, such as on the order confirmation page.

Headers

string
The UUID of the platform that displays these offers. Required with an API key. Optional with an OAuth access token that already carries your platform.

Response

object[]
required
The offers to show. The array is empty when the brand has no active campaign or no available offers.
Each offer returned counts as one view for your platform. Request offers when you are about to show them, not ahead of time. This endpoint allows 3,000 requests per minute; see Rate limiting.

Errors