listCampaigns( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Returns a list of email campaigns.

Default sort by date_updated in desc order.

Admin Method

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Email Marketing
Learn more about permission scopes.
Method Declaration
Method Parameters

Options to use when getting the list of campaigns.

Return Type:Promise<ListCampaignsResponse>
Was this helpful?