Campaign API
Get Campaigns
Campaign API
Get Campaigns
Endpoint to retrieve campaigns. Campaigns can be filtered by Vendor ID and status.
It is expected to use for getting all campaigns of a marketplace & all campaigns of a vendor in dashboards. Filtering by status is expected to use at review page getting campaigns approved, pending tabs.
GET
/
public
/
v1
/
campaign-service
/
campaigns
Query Parameters
vendor_id
string
The ID of the vendor. Omit to get campaigns for all vendors.
Minimum length:
1status
enum<string>
Filter by the approval status of banner campaigns.
Available options:
approved, pending, rejected offset
integer
default: 0The pagination offset.
Required range:
x > 0limit
integer
default: 100The pagination limit.
Required range:
0 < x < 100is_active
boolean
Filter by active/inactive campaigns.
sort_by_date
enum<string>
Optional sort by date of campaign creation.
Available options:
asc, desc Response
200 - application/json
The campaigns response.
campaigns
object[]
requiredAn array of campaigns.
hasMore
boolean
requiredWhether this is the last page of results or not.
next
object
The parameters that should be used to fetch the next page.