Campaigns (Collection)¶
Campaign collection endpoint.
Endpoint¶
| Method | URL |
|---|---|
GET |
/campaigns |
GET /campaigns¶
| Parameter | Type | Description |
|---|---|---|
page |
int | Result page. Defaults to 1. |
pagesize |
int | Max campaigns per page. Range [10, 100]. Defaults to 10. |
sort |
string | field,direction pair. Field can be any campaign field. Direction: ASC or DESC. Defaults to when,DESC. |
state |
string | Filter by campaign state. Defaults to all states. |
q |
string | Search string filter. Defaults to no filtering. |
Returns: The campaign collection.