Skip to main content
GET
{micro_service_base_url}
/
stores
/
company
/
{company_id}
/
campaigns
{
  "campaigns": [
    {
      "id": "<string>",
      "name": "<string>",
      "image": "<string>",
      "start_date": "<string>",
      "end_date": "<string>",
      "status": "<string>"
    }
  ],
  "pagination": {
    "total_campaigns": 123,
    "current_page": 123,
    "total_pages": 123,
    "has_next_page": true,
    "has_previous_page": true
  }
}
This endpoint provides comprehensive access to all campaigns associated with a company. It supports pagination, filtering by status, and sorting to efficiently manage large numbers of campaigns.
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

company_id
string
required
The unique identifier of the company whose campaigns you want to retrieve

Query Parameters

limit
integer
default:"20"
Maximum number of campaigns to return per request (max 100)
offset
integer
default:"0"
Number of campaigns to skip for pagination
order
string
default:"DESC"
Sort order for campaigns: “ASC” (ascending) or “DESC” (descending)
status
string
Filter campaigns by status: “active”, “inactive”, “scheduled”, “expired”
Search campaigns by name or description
start_date_from
string
Filter campaigns starting after this date (YYYY-MM-DD)
start_date_to
string
Filter campaigns starting before this date (YYYY-MM-DD)

Response

campaigns
array
Array of campaign objects
pagination
object
Pagination information for the response

Response Example

[
  {
    "id": "1000007",
    "image": "https://lula-stores-service-staging.s3.amazonaws.com/company/1000058/campaigns/1000007/1741976976661.webp",
    "name": "Summer Essentials Campaign",
    "start_date": "2025-06-01",
    "end_date": "2025-08-31",
    "status": "active"
  },
  {
    "id": "1000008",
    "image": "https://lula-stores-service-staging.s3.amazonaws.com/company/1000058/campaigns/1000008/1741977281470.webp",
    "name": "Back to School Special",
    "start_date": "2025-08-15",
    "end_date": "2025-09-15",
    "status": "scheduled"
  },
  {
    "id": "1000009",
    "image": "https://lula-stores-service-staging.s3.amazonaws.com/company/1000058/campaigns/1000009/1741977365382.webp",
    "name": "Holiday Season Promotions",
    "start_date": "2025-11-01",
    "end_date": "2025-12-31",
    "status": "scheduled"
  },
  {
    "id": "1000010",
    "image": "https://lula-stores-service-staging.s3.amazonaws.com/company/1000058/campaigns/1000010/1744591882710.webp",
    "name": "Spring Fresh Campaign",
    "start_date": "2025-03-01",
    "end_date": "2025-05-31",
    "status": "active"
  }
]
Get Active Campaigns Only
GET {{micro_service_base_url}}/stores/company/{{company_id}}/campaigns?status=active
Search Campaigns by Name
GET {{micro_service_base_url}}/stores/company/{{company_id}}/campaigns?search=summer
Get Campaigns with Pagination
GET {{micro_service_base_url}}/stores/company/{{company_id}}/campaigns?limit=10&offset=20
Get Upcoming Campaigns
GET {{micro_service_base_url}}/stores/company/{{company_id}}/campaigns?status=scheduled&order=ASC
Filter by Date Range
GET {{micro_service_base_url}}/stores/company/{{company_id}}/campaigns?start_date_from=2025-06-01&start_date_to=2025-12-31
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

active: Currently running campaigns
  • Promotions are being applied
  • Visible to customers
  • Within start and end date range
inactive: Paused or disabled campaigns
  • Not currently applying promotions
  • Hidden from customers
  • Can be reactivated at any time
scheduled: Future campaigns
  • Set to start automatically on start_date
  • Not yet visible to customers
  • Can be modified before activation
expired: Past campaigns
  • End date has passed
  • No longer applying promotions
  • Archived for historical reference

Use Cases

Campaign Dashboard
  • Display overview of all active campaigns
  • Monitor campaign performance at a glance
  • Quick access to campaign management actions
Campaign Planning
  • Review upcoming scheduled campaigns
  • Plan campaign calendars and timing
  • Identify gaps in marketing coverage
Performance Analysis
  • Compare active vs inactive campaigns
  • Analyze campaign timing and duration
  • Identify successful campaign patterns
Campaign Administration
  • Bulk campaign management operations
  • Search and filter for specific campaigns
  • Organize campaigns by status and timing

Error Responses

Company Not Found
{
  "error": "Company not found",
  "message": "The specified company does not exist",
  "code": "COMPANY_NOT_FOUND"
}
Invalid Parameters
{
  "error": "Invalid parameters",
  "message": "Limit must be between 1 and 100",
  "code": "INVALID_PARAMETERS"
}
Invalid Date Format
{
  "error": "Invalid date format",
  "message": "Date must be in YYYY-MM-DD format",
  "code": "INVALID_DATE_FORMAT"
}
Large Result Sets: When requesting campaigns without pagination, large companies may experience slower response times. Always use pagination for production applications.
I