Admin Marketing: Communications
List marketing campaigns
Filters: name (LIKE), status (0/1), marketing_template_id, marketing_event_id, channel_id, customer_group_id. Sort: id (default desc), name.
get/marketing/campaigns
Request
- Base URLhttp://localhost:8000/api/admin
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
pageinteger
Example:1
Page number.
per_pageinteger
Example:10
Items per page (default 10, max 50).
namestring
Partial name match.
statusinteger
Enabled flag (0/1).
marketing_template_idinteger
Filter by template id.
marketing_event_idinteger
Filter by event id.
channel_idinteger
Filter by channel id.
customer_group_idinteger
Filter by customer group id.
sort'id' | 'name'
Sort column.
order'asc' | 'desc'
Sort direction.
Response
Paginated list in the { data, meta } envelope. The channel / customerGroup / marketingTemplate / marketingEvent objects are detail-only and null on list rows.
Changes
No recorded changes to this operation across all 8 revisions of this API.