Skip to main content
The Toppie API enables secure, programmatic access to Toppie’s unified retail media platform. Whether you’re automating campaign management, building custom dashboards, or integrating Toppie data into existing workflows, the API provides the foundation for scaling retail media operations beyond the UI.
The Toppie API provides public endpoints to manage and analyze agency accounts, campaigns, and financial activity across multiple retail partners.

Toppie API Reference

View the complete API documentation with all available endpoints

​
Key Benefits

  • Automate Campaign Operations - Build workflows to manage campaigns across retailers without manual intervention
  • Custom Integrations - Connect Toppie data to BI tools and internal systems
  • Secure Access Control - Role-based permissions for data and capabilities

​
API Capabilities

The Toppie API provides comprehensive functionality through the following endpoints:
Upload, update, and manage product catalogs across retail partners. Keep inventory synchronized and ensure accurate product information for your campaigns.
Create, modify, pause, and delete campaigns programmatically. Set budgets, targeting parameters, and bidding strategies for both Sponsored Listings and Banner Ads.
Retrieve real-time performance data including impressions, clicks, conversions, ROAS metrics, and ad spend. Generate custom reports with specific date ranges and metric selections.
Track account balances, view transaction history, and manage billing programmatically. Implement custom budget allocation algorithms based on performance metrics.

​
Authentication

All Toppie API requests require authentication using API keys with token-based authentication. This ensures secure access to your campaigns and data.

​
Getting Your API Key

1

Navigate to Settings

Access Settings in your Toppie dashboard navigation
2

Select API Integration

Choose API Integration from the left-hand navigation menu
3

Create New Key

Click the ”+ New API Key” button to generate a new key
4

Save Immediately

Copy and save your API key immediately—it will only be displayed once for security reasons

​
Using Your API Key

Include your API key in the Authorization header of each request: 
curl -X GET "https://api.topsort.com/toppie/v1/campaigns" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

​
Security Best Practices

Security Guidelines:
  • Never share API keys in code repositories or public channels
  • Rotate keys regularly for enhanced security
  • Use environment variables or secure vaults to store keys
  • Monitor API usage for any unusual activity
  • Implement proper access controls in your applications

​
Common Use Cases

Automate campaign creation, budget adjustments, and performance optimization based on predefined rules and triggers. Build workflows that respond to performance thresholds or market conditions.Example scenarios:
  • Automatically pause campaigns when ROAS drops below target
  • Create new campaigns based on product catalog updates
  • Adjust bids dynamically based on time of day or inventory levels

​
API Documentation

For complete API reference documentation including endpoint specifications, parameters, request/response examples, and error handling guidelines, visit the Toppie API Reference.
Agustin - Integrations Team MemberAmelia - Integrations Team MemberBernardita - Integrations Team MemberBorumy - Integrations Team MemberFelipe - Integrations Team MemberGui - Integrations Team MemberJaviera - Integrations Team MemberLinn - Integrations Team MemberMarcio - Integrations Team MemberMateus - Integrations Team MemberMax - Integrations Team MemberRodrigo - Integrations Team Member

Need help with your Topsort integration?

Talk to us, the integrations engineering team.Reach us via your dedicated messaging channel or at support@topsort.com.If you're not a customer yet, book a demo with our sales team instead.