Skip to main content
POST
Campaigns list

Authorizations

Authorization
string
header
required

A personal API key (adside_pat_…) or a token from adside login. Either carries the permissions of the person it belongs to.

Path Parameters

workspaceId
string
required
Minimum string length: 1

Body

application/json
ad_account_id
string

Reddit ad account id (a2_…). Omit it: it defaults to the ad account this workspace is connected to, and any other account is refused.

status
enum<string>

Filter on configured_status. ARCHIVED and DELETED objects are hidden unless asked for.

Available options:
ACTIVE,
PAUSED,
ARCHIVED,
DELETED
name_contains
string

Case-insensitive substring of the campaign name.

include_archived
boolean
default:false

Include ARCHIVED and DELETED campaigns (hidden by default).

limit
integer
default:100

Maximum rows to return (bounds the answer, not the scan).

Required range: 1 <= x <= 500

Response

200 - application/json

Success