> ## Documentation Index
> Fetch the complete documentation index at: https://developers.hubspot.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
---
id: 0643fba1-b49d-4380-925c-2747e0f87a06
---
# Retrieve budget details
> Retrieve detailed budget and spending information, including totals, for a specific marketing campaign. This endpoint provides insights into the financial aspects of a campaign, helping users to manage and analyze budget allocations and spending patterns effectively.
export const ScopesList = ({scopes = [], description = "This API requires one of the following scopes:"}) => {
if (!scopes || scopes.length === 0) {
return null;
}
const sortedScopes = scopes.sort((a, b) => a.localeCompare(b));
return
;
};
## OpenAPI
````yaml specs/2026-09/marketing-campaigns-public-api-v2026-09.json GET /marketing/campaigns/2026-09/{campaignGuid}/budget/totals
openapi: 3.0.1
info:
title: Marketing Campaigns Public Api
description: Basepom for all HubSpot Projects
version: 2026-09
x-hubspot-product-tier-requirements:
marketing: FREE
sales: FREE
service: FREE
cms: FREE
commerce: FREE
crmHub: FREE
dataHub: FREE
servers:
- url: https://api.hubapi.com
security: []
tags:
- name: Advanced
- name: Assets
- name: Basic
- name: Batch
- name: Budget
- name: Reports
- name: Spend
paths:
/marketing/campaigns/2026-09/{campaignGuid}/budget/totals:
get:
tags:
- Budget
summary: Retrieve budget details
description: >-
Retrieve detailed budget and spending information, including totals, for
a specific marketing campaign. This endpoint provides insights into the
financial aspects of a campaign, helping users to manage and analyze
budget allocations and spending patterns effectively.
operationId: get-/marketing/campaigns/2026-09/{campaignGuid}/budget/totals
parameters:
- name: campaignGuid
in: path
description: >-
The unique identifier of the campaign for which budget totals are
being retrieved.
required: true
style: simple
explode: false
schema:
type: string
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/PublicBudgetTotals'
default:
$ref: '#/components/responses/Error'
description: ''
security:
- oauth2:
- marketing.campaigns.read
components:
schemas:
PublicBudgetTotals:
required:
- budgetItems
- currencyCode
- spendItems
type: object
properties:
budgetItems:
type: array
description: >-
An array of budget items associated with the campaign, each
represented by a PublicBudgetItem object.
items:
$ref: '#/components/schemas/PublicBudgetItem'
budgetTotal:
type: number
description: >-
The total amount of the budget allocated for the campaign, expressed
as a number.
currencyCode:
type: string
description: >-
The currency code used for the budget and spending amounts,
represented as a string. Valid values include standard currency
codes such as 'USD', 'EUR', 'JPY', etc.
enum:
- AED
- AFN
- ALL
- AMD
- ANG
- AOA
- ARS
- AUD
- AWG
- AZN
- BAM
- BBD
- BDT
- BGN
- BHD
- BIF
- BMD
- BND
- BOB
- BOV
- BRL
- BSD
- BTN
- BWP
- BYN
- BZD
- CAD
- CDF
- CHE
- CHF
- CHW
- CLF
- CLP
- CNY
- COP
- COU
- CRC
- CUC
- CUP
- CVE
- CZK
- DJF
- DKK
- DOP
- DZD
- EGP
- ERN
- ETB
- EUR
- FJD
- FKP
- GBP
- GEL
- GHS
- GIP
- GMD
- GNF
- GTQ
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- ILS
- INR
- IQD
- IRR
- ISK
- JMD
- JOD
- JPY
- KES
- KGS
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LYD
- MAD
- MDL
- MGA
- MKD
- MMK
- MNT
- MOP
- MRU
- MUR
- MVR
- MWK
- MXN
- MXV
- MYR
- MZN
- NAD
- NGN
- NIO
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLN
- PYG
- QAR
- RON
- RSD
- RUB
- RWF
- SAR
- SBD
- SCR
- SDG
- SEK
- SGD
- SHP
- SLL
- SOS
- SRD
- SSP
- STN
- SVC
- SYP
- SZL
- THB
- TJS
- TMT
- TND
- TOP
- TRY
- TTD
- TWD
- TZS
- UAH
- UGX
- USD
- USN
- UYI
- UYU
- UZS
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XBA
- XBB
- XBC
- XBD
- XCD
- XDR
- XOF
- XPD
- XPF
- XPT
- XSU
- XUA
- YER
- ZAR
- ZMW
- ZWL
remainingBudget:
type: number
description: >-
The remaining budget available for the campaign, calculated as the
difference between the budgetTotal and spendTotal, expressed as a
number.
spendItems:
type: array
description: >-
An array of spend items associated with the campaign, each
represented by a PublicSpendItem object.
items:
$ref: '#/components/schemas/PublicSpendItem'
spendTotal:
type: number
description: The total amount spent in the campaign, expressed as a number.
PublicBudgetItem:
required:
- amount
- createdAt
- id
- name
- order
- updatedAt
type: object
properties:
amount:
type: number
description: >-
The financial amount allocated to this budget item, represented as a
number.
createdAt:
type: integer
description: >-
A Unix timestamp in milliseconds indicating when this budget item
was created.
format: int64
description:
type: string
description: A description of the budget item, represented as a string.
id:
type: string
description: The unique identifier for this budget item, represented as a string.
name:
type: string
description: The name of the budget item, represented as a string.
order:
type: integer
description: >-
An integer representing the order or sequence of this budget item
within the campaign.
format: int32
updatedAt:
type: integer
description: >-
A Unix timestamp in milliseconds indicating when this budget item
was last updated.
format: int64
PublicSpendItem:
required:
- amount
- createdAt
- id
- name
- order
- updatedAt
type: object
properties:
amount:
type: number
description: >-
The financial amount associated with the spend item, represented as
a number.
createdAt:
type: integer
description: >-
A Unix timestamp in milliseconds indicating when the spend item was
created.
format: int64
description:
type: string
description: A string providing additional details about the spend item.
id:
type: string
description: The unique identifier for the spend item, represented as a string.
name:
type: string
description: The name of the spend item, represented as a string.
order:
type: integer
description: An integer indicating the order or sequence of the spend item.
format: int32
updatedAt:
type: integer
description: >-
A Unix timestamp in milliseconds indicating when the spend item was
last updated.
format: int64
Error:
required:
- category
- correlationId
- message
type: object
properties:
category:
type: string
description: The error category, represented as a string.
context:
type: object
additionalProperties:
type: array
items:
type: string
description: >-
An object providing context about the error condition, where each
key is a string and each value is an array of strings.
example: >-
{invalidPropertyName=[propertyValue], missingScopes=[scope1,
scope2]}
correlationId:
type: string
description: >-
A unique identifier for the request, formatted as a UUID. This
should be included with any error reports or support tickets.
format: uuid
example: aeb5f871-7f07-4993-9211-075dc63e7cbf
errors:
type: array
description: >-
An array providing further information about the error, with each
item being an ErrorDetail object.
items:
$ref: '#/components/schemas/ErrorDetail'
links:
type: object
additionalProperties:
type: string
description: >-
A map of link names to associated URIs containing documentation
about the error or recommended remediation steps, represented as an
object with string values.
message:
type: string
description: >-
A human readable message describing the error along with remediation
steps where appropriate. It is a string.
example: An error occurred
subCategory:
type: string
description: >-
A specific category that contains more specific detail about the
error, represented as a string.
description: >-
Represents an error response returned by the API when an operation
fails. This component is used in various endpoints to provide detailed
information about the error encountered.
example:
message: Invalid input (details will vary based on the error)
correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf
category: VALIDATION_ERROR
links:
knowledge-base: https://www.hubspot.com/products/service/knowledge-base
ErrorDetail:
required:
- message
type: object
properties:
code:
type: string
description: The status code associated with the error detail. This is a string.
context:
type: object
additionalProperties:
type: array
items:
type: string
description: >-
Context about the error condition, provided as an object where each
key is a context name and the value is an array of strings providing
additional information.
example: '{missingScopes=[scope1, scope2]}'
in:
type: string
description: >-
The name of the field or parameter in which the error was found.
This is a string.
message:
type: string
description: >-
A human readable message describing the error along with remediation
steps where appropriate. This is a string.
subCategory:
type: string
description: >-
A specific category that contains more specific detail about the
error. This is a string.
description: >-
Represents detailed information about an error that occurred in the API.
This component is used to provide additional context and specifics about
errors, typically as part of an error response.
responses:
Error:
description: An error occurred.
content:
'*/*':
schema:
$ref: '#/components/schemas/Error'
securitySchemes:
oauth2:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://app.hubspot.com/oauth/authorize
tokenUrl: https://api.hubapi.com/oauth/v1/token
scopes:
marketing.campaigns.read: ''
marketing.campaigns.revenue.read: ''
marketing.campaigns.write: ''
````
{product.name} -
{product.level}
)}