Skip to main content
GET
List rule summaries

Authorizations

Authorization
string
header
required

A workspace-scoped key with read ability and actions.rules.index or actions.rules.show access to the bound account. Send Accept: application/json.

Path Parameters

workspace
integer
required

The workspace ID

Query Parameters

page
integer
Required range: x >= 1
account_id
integer

Optional account ID, ignored by an account-bound key. An unbound key requires exactly one active available advertising account with an active connection; omission uses that account and a supplied ID must match it. Multiple active accounts return 422 even when account_id is supplied.

Required range: x >= 1
platform_ad_account_id
integer

Optional account ID, ignored by an account-bound key. An unbound key requires exactly one active available advertising account with an active connection; omission uses that account and a supplied ID must match it. Multiple active accounts return 422 even when account_id is supplied. Alias of account_id; account_id takes precedence when both are supplied.

Required range: x >= 1
cursor
string

Continue using next_cursor with the same filters; rule lists use an immutable rule ID, other lists an offset or object ID.

per_page
integer
default:25

Maximum complete rows; the byte budget may return fewer. Defaults to 25.

Required range: 1 <= x <= 100

Response

Bounded rows; no nested history is included in rule summaries. Result projections share the 80,000-byte MCP JSON budget; defaults are bounded, next_cursor continues complete rows, and oversized single rows are explicitly refused. Plan creative continuation uses the read endpoint; proposal continuation uses the batch read endpoint.

rules
object
required

Complete projection rows are paged within 80,000 JSON bytes, accounting for both MCP representations. Defaults are bounded. Follow next_cursor with the same scope and filters. One oversized row is explicitly refused; fields are never silently clipped.