- Social Accounts
- Ad Accounts
- Assets
- Audiences
- Campaigns
- Contacts
- Get contact by clientContactIdGET
- Get contact by emailGET
- Add contact to the list by idPUT
- Remove contact from the list by idDELETE
- Add contact to the list by namePUT
- Remove contact from the list by nameDELETE
- Get contact by phoneNumber1GET
- Get all contactsGET
- Create contactPOST
- Upsert contactPUT
- Get contactGET
- Update contactPUT
- Delete contactDELETE
- Get total number of contactsGET
- Upsert multiple contactsPUT
- Delete multiple contactsDELETE
- Contact loginPOST
- Contact logoutPOST
- Contact get subscriptionsGET
- Replace contact's subscriptions (full set)PUT
- Adjust contact's subscriptions (partial)PATCH
- Unsubscribe a contact from all listsPATCH
- Get contact by clientContactId
- Carts
- Deals
- Delivery
- Events
- Forms
- Notifications
- Lists
- Get Lists
- Create List
- Get List
- Update List
- Delete List
- Get List by name
- Update List by name
- Delete List by name
- Get number of contacts for a list
- Get number of contacts for a list by name
- Get contact counts for all lists (grouped by category)
- Upsert Lists (bulk)
- Get List categories
- Create List category
- Get List category
- Update List category
- Delete List category
- Get List category by name
- Update List category by name
- Delete List category by name
- Upsert List categories (bulk)
- Products
- Orders
- Scenarios
- Smartflows
- Triggers
- Actions
- Targets
- Get smartflows
- Create smartflow
- Get smartflow
- Update smartflow
- Delete smartflow
- Get smartflow structure
- Generate smartflow (AI)
- Pause/Resume/Cancel smartflow
- Execute smartflow
- Validate smartflow
- Export smartflow
- Import smartflow
- Duplicate smartflow
- Get smartflow actions
- Archive smartflow
- Get templates
- Create template
- Get template actions
- Get folders
- Create folder
- Modify folder
- Delete folder
- Get Product in Cart is back in Stock trigger
- Update Product in cart is back in stock trigger
- Delete Product in cart is back in stock trigger
- Create Product in cart is back in stock trigger
- Get Product in Cart discounted trigger
- Update Product in Cart discounted trigger
- Delete Product in Cart discounted trigger
- Create Product in Cart discounted trigger
- Get Product in cart running out trigger
- Update Product in cart running out trigger
- Delete Product in cart running out trigger
- Create Product in cart running out trigger
- Get Product purchased trigger
- Update Product purchased trigger
- Delete Product purchased trigger
- Create Product purchased trigger
- Get Recently purchased trigger
- Update Recently purchased trigger
- Delete Recently purchased trigger
- Create Recently purchased trigger
- Get Checkout visited trigger
- Update Checkout visited trigger
- Delete Checkout visited trigger
- Create Checkout visited trigger
- Get Order cancelled trigger
- Delete Order cancelled trigger
- Create Order cancelled trigger
- Get Invoice confirmation trigger
- Delete Invoice confirmation trigger
- Create Invoice confirmation trigger
- Get Return confirmation trigger
- Delete Return confirmation trigger
- Create Return confirmation trigger
- Get Website search trigger
- Update Website search trigger
- Delete Website search trigger
- Create Website search trigger
- Get Campaign sent trigger
- Update Campaign sent trigger
- Delete Campaign sent trigger
- Create Campaign sent trigger
- Get Shipping confirmed trigger
- Update Shipping confirmed trigger
- Delete Shipping confirmed trigger
- Create Shipping confirmed trigger
- Get Website Viewed trigger
- Update Website Viewed trigger
- Delete Website Viewed trigger
- Create Website Viewed trigger
- Get Filter target
- Update Filter target
- Delete Filter target
- Create Filter target
- Get Merge target
- Delete Merge target
- Create Merge target
- Get Split target
- Update Split target
- Delete Split target
- Create Split target
- Get Splitter target
- Update Splitter target
- Delete Splitter target
- Create Splitter target
- Get Condition target
- Update Condition target
- Delete Condition target
- Create Condition target
- Get A/B test target
- Update AB test target
- Delete AB test target
- Create AB test target
- Get Send mail action
- Update Send email action
- Delete Send mail action
- Create Send mail action
- Get Send sms action
- Update Send sms action
- Delete Send sms action
- Create Send sms action
- Get Send social post action
- Update Send social post action
- Delete Send social post action
- Create Send social post action
- Get Send NPS action
- Update Send NPS action
- Delete Send NPS action
- Create Send NPS action
- Get Webhook action
- Update Webhook action
- Delete Webhook action
- Create Webhook action
- Get Meta audience action
- Update Meta audience action
- Delete Meta audience action
- Create Meta audience action
- Get Sklik audience action
- Update Sklik audience action
- Delete Sklik audience action
- Create Sklik audience action
- Connect Sklik account
- Disconnect Sklik account
- Get Sklik audiences for action
- Get Delay action
- Update Delay action
- Delete Delay action
- Create Delay action
- Get Landing page action
- Update Landing page action
- Delete Landing page action
- Create Landing page action
- Get Add tag action
- Update Add tag action
- Delete Add tag action
- Create Add tag action
- Get Remove tag action
- Update Remove tag action
- Delete Remove tag action
- Create Remove tag action
- Get Unsubscribe action
- Update Unsubscribe action
- Delete Unsubscribe action
- Create Unsubscribe action
- Get list of contact fields to update
- Get Update contact action
- Update Update contact action
- Delete Update contact action
- Create Update contact action
- Get Popup action
- Update Popup action
- Delete Popup action
- Create Popup action
- Website
- Tags
- Context
- Admin
- Jobs
- Schemas
- Audience
- CampaignType
- Contact
- CampaignChannel
- CampaignState
- Campaign
- Context
- CreateActionResponse
- TeaserFontFamily
- TeaserFontWeight
- TeaserCloseButtonSize
- TeaserCloseButtonPosition
- TeaserPosition
- NotificationSeverity
- NotificationChannel
- Tag
- TagCategory
- List
- ListCategory
- Product
- SmartflowTemplateAction
- SmartflowAction
- SmartflowState
- SmartflowCompletedState
- SocialNetworkType
- SocialNetworkEntityType
- SocialNetworkEntity
- SocialNetworkUser
- Smartflow
- SmartflowFolder
- SocialAccount
- AudienceInput
- EmailAsset
- SmsAsset
- PushAsset
- Cron
- SocialAccountsResponse
- AdAccount
- AdAccountsResponse
- AudiencesResponse
- ProductsResponse
- ProductsCategoriesResponse
- ProductTagsResponse
- SmartflowsResponse
- SmartflowFoldersResponse
- SmartflowActionsResponse
- SmartflowTemplateActionsResponse
- Paging
- TeaserSettings
- WebsiteSettings
- General rules
- PermId
- Events
Get campaigns
GET
/campaigns
Request
Query Params
Header Params
Responses
🟢200
application/json
Bodyapplication/json
🟠400
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/campaigns?dateFrom=2025-05-15&dateTo=2025-05-25&categoryId=10&type=onetime&channel=email&state=running&q=christmass&limit=10&offset=5' \
--header 'Authorization: Bearer <token> (required)' \
--header 'X-User-Id: <user id> (required)'Response Response Example
200 - Success
{
"campaigns": [
{
"campaignId": "35a5d0e7-934f-4d50-9f4d-8c370ca72111",
"name": "Some campaign",
"state": "",
"type": [
""
],
"channel": [
""
],
"dateFrom": "2025-04-15T08:00:00+02:00",
"dateTo": "2025-05-15T12:00:00+02:00",
"created": "2025-04-15T08:00:00+02:00"
}
],
"paging": {
"offset": 21,
"limit": 40,
"totalItems": 100,
"totalPages": 5,
"links": [
"href: `?offset=40&limit=60`",
"rel: `next`"
]
}
}Modified at 2026-06-11 02:37:32