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.
advertising:readGrant 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
- 200
- 401
- 403
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.