API DocumentationCampaign: GetList
Method to get a list of campaigns.
Resource URL
https://api.wbsrvc.com/Campaign/GetList/
Method
POST
Parameters
| user_key Required |
User Key of the user who initiates the call. Type: string |
| status Optional |
Filter using the campaign status. Type: string - possible value 'ongoing', 'closed' |
| name Optional |
Filter using the campaign name. Type: string |
| sort_by Optional |
Sort resulting campaigns. Type: string - possible value 'created_on', 'name' |
| direction Optional |
Direction of the sorting. Type: string - possible value 'asc', 'desc' |
| limit Optional |
Limit the number of resulting campaigns. Type: integer |
| offset Optional |
Offset the beginning of resulting campaigns. Type: integer |
| count Optional |
Return the number of campaigns. Type: string - possible value 'true', 'false' |
| client_id Optional |
Client ID of the client in which the campaigns are located. Type: integer |