List campaigns

get

https://production-api.shoutaboutus.com/api/v1/campaign/list

Get the campaigns for an account, with status, channels, and recipient counts. Use this to show campaigns in your own UI or to find a campaign_id. Filter by status or location, or search by name; results are paginated.

Prerequisites: a bearer token.

Authentication: Account token. Lists the campaigns of your own account; a user limited to assigned locations only sees those locations' campaigns.

Rate limit: none.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

status

string

enum

Defaults to draft

draft, active (scheduled or in progress) or inactive (completed, paused or cancelled). Leave it out for all.

Allowed:

location_id

integer

Defaults to 3007

Only campaigns for this location. Must be an existing location.

search_field

string

enum

Defaults to name

The field to search, used with search_value: name, description, store_name, store_id, storeId or type.

Allowed:

search_value

string

length ≤ 255

Defaults to Summer

The text to search for, up to 255 characters. Matches part of the value, except for store_id and type, which must match exactly.

sort_field

string

enum

Defaults to created_at

The field to sort by. Default created_at. One of name, status, created_at, updated_at, scheduled_at, started_at, completed_at, request_file_status, request_per_day, request_frequency, request_delay, next_execution_time, total_audience, total_valid_phones, total_valid_emails, store_name, storeId, type.

sort_by

string

enum

Defaults to desc

asc or desc (either case). Default desc.

Allowed:

page

integer

≥ 1

Defaults to 1

The page to return, from 1. Default 1.

per_page

integer

≤ 100

Defaults to 10

Campaigns per page, 10–100. Default 15. Values below 10 are raised to 10; above 100 returns 422.

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A page of campaigns, or an empty data array when none match.

401The token is missing, expired or invalid.

422A filter value isn't allowed, location_id doesn't exist, or per_page is above 100.

500Unexpected server error.