Get Campaigns

Get Campaigns

curl --request GET \
  --url 'https://api.example.com/{{micro_service_base_url}}/stores/company/{{company_id}}/campaigns'

const options = {method: 'GET'};

fetch('https://api.example.com/{{micro_service_base_url}}/stores/company/{{company_id}}/campaigns', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/{{micro_service_base_url}}/stores/company/{{company_id}}/campaigns",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/{{micro_service_base_url}}/stores/company/{{company_id}}/campaigns"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/{{micro_service_base_url}}/stores/company/{{company_id}}/campaigns")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "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
  }
}

GET

{micro_service_base_url}

stores

company

{company_id}

campaigns

Get Campaigns

curl --request GET \
  --url 'https://api.example.com/{{micro_service_base_url}}/stores/company/{{company_id}}/campaigns'

const options = {method: 'GET'};

fetch('https://api.example.com/{{micro_service_base_url}}/stores/company/{{company_id}}/campaigns', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/{{micro_service_base_url}}/stores/company/{{company_id}}/campaigns",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/{{micro_service_base_url}}/stores/company/{{company_id}}/campaigns"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/{{micro_service_base_url}}/stores/company/{{company_id}}/campaigns")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "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

string

required

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

Query Parameters

integer

default:"20"

Maximum number of campaigns to return per request (max 100)

integer

default:"0"

Number of campaigns to skip for pagination

string

default:"DESC"

Sort order for campaigns: “ASC” (ascending) or “DESC” (descending)

string

Filter campaigns by status: “active”, “inactive”, “scheduled”, “expired”

string

Search campaigns by name or description

string

Filter campaigns starting after this date (YYYY-MM-DD)

string

Filter campaigns starting before this date (YYYY-MM-DD)

Response

array

Array of campaign objects

Show Campaign Object

string

Unique campaign identifier

string

Campaign name

string

URL to campaign image asset

string

Campaign start date (YYYY-MM-DD)

string

Campaign end date (YYYY-MM-DD)

string

Current campaign status

object

Pagination information for the response

Show Pagination Details

integer

Total number of campaigns matching filters

integer

Current page number (calculated from offset and limit)

integer

Total number of pages available

boolean

Whether there are more campaigns available

boolean

Whether there are previous campaigns available

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"
  }
]

Filter and Search Examples

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

Understanding Campaign Status

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

Common Campaign Management Scenarios

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

Common Error Scenarios

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.

API Documentation - Legacy

API Documentation - Latest

Path Parameters

Query Parameters

Response

Response Example

Campaign Status Overview

Use Cases

Error Responses

​Path Parameters

​Query Parameters

​Response

​Response Example

​Campaign Status Overview

​Use Cases

​Error Responses

Path Parameters

Query Parameters

Response

Response Example

Campaign Status Overview

Use Cases

Error Responses