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
account_id
string

X ads account id (e.g. 18ce55xcrlv). Omit it: it defaults to the ads account this workspace is connected to, and any other account is refused.

status
enum<string>

Filter on entity_status. Deleted objects are hidden unless with_deleted is set.

Available options:
ACTIVE,
PAUSED,
DRAFT
name_contains
string

Case-insensitive substring of the campaign name.

funding_instrument_id
string

Only campaigns on this funding instrument (server-side filter).

Pattern: ^[0-9a-z]{1,12}$
with_deleted
boolean
default:false

Include deleted campaigns (X keeps them listable).

with_draft
boolean
default:true

Include DRAFT campaigns.

limit
integer
default:100

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

Required range: 1 <= x <= 1000

Response

200 - application/json

Success