Skip to main content

List Budget Plans

GET 

/api/advertising/budget-plans

Returns a paginated list of budget plans, newest month first (then newest ID first). Sorting is fixed; no sort parameter is accepted.

Required scope: advertising:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Filters: filter[month] (exact first-of-month date, Y-m-d, e.g. 2026-11-01; other formats are ignored) and filter[status] (draft, active, archived). Pagination: per_page (default 10).

Requires the advertising.view permission.

Available only when the tenant has both the advertising and advertising-manager features enabled; otherwise every route here returns 404.

Request​

Responses​

OK

Response Headers
    Content-Type