Skip to main content
POST
Campaign-groups 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

LinkedIn Ad Account ID. Omit it: it defaults to the account this workspace is connected to, and any other account is refused.

status
enum<string>

Filter by campaign group status

Available options:
ACTIVE,
ARCHIVED,
CANCELED,
DRAFT,
PAUSED,
PENDING_DELETION,
REMOVED
name
string

Filter by campaign group name

test
boolean

Filter by test (true) or non-test (false) campaign groups

sort_order
enum<string>

Sort order by campaign group ID (default: ASCENDING)

Available options:
ASCENDING,
DESCENDING
page_size
number
default:100

Number of results per page (max 1000)

Required range: 1 <= x <= 1000
page_token
string

Cursor token for next page of results

Response

200 - application/json

Success