This endpoint returns essential campaign information optimized for list views and campaign management interfaces. For detailed campaign information, use the Get Campaign Details endpoint.
Path Parameters
The unique identifier of the company whose campaigns you want to retrieve
Query Parameters
Maximum number of campaigns to return per request (max 100)
Number of campaigns to skip for pagination
Sort order for campaigns: “ASC” (ascending) or “DESC” (descending)
Filter campaigns by status: “active”, “inactive”, “scheduled”, “expired”
Search campaigns by name or description
Filter campaigns starting after this date (YYYY-MM-DD)
Filter campaigns starting before this date (YYYY-MM-DD)
Response
Array of campaign objects
Pagination information for the response
Response Example
Filter and Search Examples
Filter and Search Examples
Get Active Campaigns OnlySearch Campaigns by NameGet Campaigns with PaginationGet Upcoming CampaignsFilter by Date Range
Performance Optimization: Use pagination (limit and offset) when dealing with companies that have many campaigns to ensure fast response times and efficient resource usage.
Search Functionality: The search parameter performs case-insensitive matching against both campaign names and descriptions, making it easy to find specific campaigns.
Campaign Status Overview
Understanding Campaign Status
Understanding Campaign Status
active: Currently running campaigns
- Promotions are being applied
- Visible to customers
- Within start and end date range
- Not currently applying promotions
- Hidden from customers
- Can be reactivated at any time
- Set to start automatically on start_date
- Not yet visible to customers
- Can be modified before activation
- End date has passed
- No longer applying promotions
- Archived for historical reference
Use Cases
Common Campaign Management Scenarios
Common Campaign Management Scenarios
Campaign Dashboard
- Display overview of all active campaigns
- Monitor campaign performance at a glance
- Quick access to campaign management actions
- Review upcoming scheduled campaigns
- Plan campaign calendars and timing
- Identify gaps in marketing coverage
- Compare active vs inactive campaigns
- Analyze campaign timing and duration
- Identify successful campaign patterns
- Bulk campaign management operations
- Search and filter for specific campaigns
- Organize campaigns by status and timing
Error Responses
Common Error Scenarios
Common Error Scenarios
Company Not FoundInvalid ParametersInvalid Date Format
Large Result Sets: When requesting campaigns without pagination, large companies may experience slower response times. Always use pagination for production applications.