> ## Documentation Index
> Fetch the complete documentation index at: https://developers.hubspot.es/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Get campaigns
> Este punto de terminación lee un lote de campañas basado en los datos de entrada proporcionados y muestra las campañas junto con sus recursos asociados.
El número máximo de elementos en una solicitud por lotes es 50.
No se garantiza que las campañas de la respuesta estarán en el mismo orden en que fueron proporcionadas en la solicitud.
Si se proporcionan ID de campañas duplicadas en la solicitud, los duplicados serán ignorados. La respuesta incluirá solo ID únicos y se mostrará sin duplicados.
export const ScopesList = ({scopes = [], description = "Esta API requiere uno de los siguientes ámbitos:"}) => {
if (!scopes || scopes.length === 0) {
return null;
}
const sortedScopes = scopes.sort((a, b) => a.localeCompare(b));
return
;
};
## OpenAPI
````yaml specs/2026-03/marketing-campaigns-public-api-v2026-03.json POST /marketing/campaigns/2026-03/batch/read
openapi: 3.0.1
info:
title: Marketing Campaigns Public Api
description: Basepom for all HubSpot Projects
version: 2026-03
x-hubspot-product-tier-requirements:
marketing: PROFESSIONAL
sales: FREE
service: FREE
cms: FREE
commerce: FREE
crmHub: FREE
dataHub: FREE
servers:
- url: https://api.hubapi.com
security: []
tags:
- name: Assets
- name: Basic
- name: Batch
- name: Budget
- name: Metrics
- name: Spend
paths:
/marketing/campaigns/2026-03/batch/read:
post:
tags:
- Batch
summary: Leer un lote de campañas
description: >
Este punto de terminación lee un lote de campañas basado en los datos de
entrada proporcionados y muestra las campañas junto con sus recursos
asociados.
El número máximo de elementos en una solicitud por lotes es 50.
No se garantiza que las campañas de la respuesta estarán en el mismo
orden en que fueron proporcionadas en la solicitud.
Si se proporcionan ID de campañas duplicadas en la solicitud, los
duplicados serán ignorados. La respuesta incluirá solo ID únicos y se
mostrará sin duplicados.
operationId: post-/marketing/campaigns/2026-03/batch/read
parameters:
- name: endDate
in: query
description: >-
Fecha de finalización para obtener métricas de recursos, con el
formato AAAA-MM-DD. Esta fecha se usa para obtener las métricas
asociadas con los recursos durante un período específico. Si no se
proporciona, no se obtendrán métricas de recursos.
Ejemplo: 2024-01-27
required: false
style: form
explode: true
schema:
type: string
- name: properties
in: query
description: >-
Una lista separada por comas de las propiedades que se devolverán en
la respuesta. Si alguna de las propiedades especificadas tiene un
valor vacío en los objetos solicitados, se ignorarán y no se
devolverán en la respuesta. Si este parámetro está vacío, la
respuesta incluirá un mapa de propiedades vacío.
Ejemplo: hs_name, hs_campaign_status, hs_notes
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: startDate
in: query
description: >-
Fecha de inicio para obtener métricas de recursos, con el formato
AAAA-MM-DD. Esta fecha se utiliza para obtener las métricas
asociadas con los recursos durante un período específico. Si no se
proporciona, no se obtendrán métricas de recursos.
Ejemplo: 2023-01-20
required: false
style: form
explode: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BatchInputPublicCampaignReadInput'
required: true
responses:
'200':
description: successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/BatchResponsePublicCampaignWithAssets'
'207':
description: multiple statuses
content:
application/json:
schema:
$ref: >-
#/components/schemas/BatchResponsePublicCampaignWithAssetsWithErrors
default:
$ref: '#/components/responses/Error'
description: ''
security:
- oauth2:
- marketing.campaigns.read
components:
schemas:
BatchInputPublicCampaignReadInput:
required:
- inputs
type: object
properties:
inputs:
type: array
description: >-
Un conjunto de objetos PublicCampaignReadInput, cada uno de los
cuales contiene el ID de una campaña que se leerá. Esta propiedad es
obligatoria.
items:
$ref: '#/components/schemas/PublicCampaignReadInput'
BatchResponsePublicCampaignWithAssets:
required:
- completedAt
- results
- startedAt
- status
type: object
properties:
completedAt:
type: string
description: >-
La marca de tiempo de cuando se completó el procesamiento de la
solicitud por lotes.
format: date-time
links:
type: object
additionalProperties:
type: string
description: >-
Una recopilación de URL con enlaces a recursos o documentación
relacionados.
requestedAt:
type: string
description: >-
La marca de tiempo de cuando se realizó inicialmente la solicitud
por lotes.
format: date-time
results:
type: array
description: >-
Un conjunto de resultados de la operación por lotes, cada uno de los
cuales representa una campaña pública con recursos.
items:
$ref: '#/components/schemas/PublicCampaignWithAssets'
startedAt:
type: string
description: >-
La marca de tiempo de cuando comenzó el procesamiento de la
solicitud por lotes.
format: date-time
status:
type: string
description: >-
El estado actual de procesamiento de la operación por lotes, con
estos posibles valores: CANCELED, COMPLETE, PENDING, PROCESSING.
enum:
- CANCELED
- COMPLETE
- PENDING
- PROCESSING
BatchResponsePublicCampaignWithAssetsWithErrors:
required:
- completedAt
- results
- startedAt
- status
type: object
properties:
completedAt:
type: string
description: La fecha y la hora en que se completó la operación por lotes.
format: date-time
errors:
type: array
description: >-
La lista de errores de lecturas de campañas individuales que
fallaron dentro del lote (por ejemplo, campaña no encontrada,
permiso denegado). Solo se incluye cuando no está vacía.
items:
$ref: '#/components/schemas/StandardError'
links:
type: object
additionalProperties:
type: string
description: Una colección de enlaces relacionados con la operación por lotes.
numErrors:
type: integer
description: >-
El número de errores que se produjeron durante la operación por
lotes.
format: int32
requestedAt:
type: string
description: La fecha y la hora en que se solicitó la operación en lote.
format: date-time
results:
type: array
description: La lista de campañas obtenidas con éxito y sus recursos asociados.
items:
$ref: '#/components/schemas/PublicCampaignWithAssets'
startedAt:
type: string
description: La fecha y la hora en que se inició la operación por lotes.
format: date-time
status:
type: string
description: >-
El estado actual de la operación por lotes, que puede ser CANCELADO,
COMPLETADO, PENDIENTE o PROCESANDO.
enum:
- CANCELED
- COMPLETE
- PENDING
- PROCESSING
PublicCampaignReadInput:
required:
- id
type: object
properties:
id:
type: string
description: El identificador único de una campaña.
PublicCampaignWithAssets:
required:
- assets
- businessUnits
- createdAt
- id
- properties
- updatedAt
type: object
properties:
assets:
type: object
additionalProperties:
$ref: '#/components/schemas/CollectionResponsePublicCampaignAsset'
description: >-
Contiene los recursos asociados a la campaña, cada uno representado
como una colección de recursos de la campaña.
businessUnits:
type: array
description: >-
Un conjunto de unidades de negocio asociadas a la campaña, cada una
representada por un objeto PublicBusinessUnit.
items:
$ref: '#/components/schemas/PublicBusinessUnit'
createdAt:
type: string
description: >-
La fecha y hora en que se creó la campaña, formateadas como una
cadena de fecha-hora.
format: date-time
id:
type: string
description: El identificador único de la campaña.
properties:
type: object
additionalProperties:
type: string
description: >-
Un mapa de pares clave-valor que representan las propiedades de la
campaña.
updatedAt:
type: string
description: >-
La fecha y hora en que se actualizó por última vez la campaña,
formateadas como una cadena de fecha-hora.
format: date-time
StandardError:
required:
- category
- context
- errors
- links
- message
- status
type: object
properties:
category:
type: string
description: Una cadena que clasifica el tipo de error.
context:
type: object
additionalProperties:
type: array
items:
type: string
description: >-
Un objeto que contiene contexto adicional sobre el error, con claves
como nombres de contexto y valores como conjuntos de cadenas.
errors:
type: array
description: >-
Un conjunto de objetos ErrorDetail que proporciona más información
sobre cada error detectado.
items:
$ref: '#/components/schemas/ErrorDetail'
id:
type: string
description: Una cadena que representa un identificador único para el error.
links:
type: object
additionalProperties:
type: string
description: >-
Un objeto que asigna nombres de enlaces a URI asociados que
contienen documentación o pasos de solución para el error.
message:
type: string
description: >-
Una cadena que contiene un mensaje comprensible para los humanos que
describe el error.
status:
type: string
description: Una cadena que indica el estado del error.
subCategory:
type: object
properties: {}
description: >-
Un objeto que proporciona detalles más específicos sobre la
categoría del error.
description: Ye olde error
Error:
required:
- category
- correlationId
- message
type: object
properties:
category:
type: string
description: La categoría del error
context:
type: object
additionalProperties:
type: array
items:
type: string
description: Contexto de la condición de error
example: >-
{invalidPropertyName=[propertyValue], missingScopes=[scope1,
scope2]}
correlationId:
type: string
description: >-
Un identificador único para la solicitud. Incluye este valor con
cualquier informe de error o ticket de asistencia.
format: uuid
example: aeb5f871-7f07-4993-9211-075dc63e7cbf
errors:
type: array
description: información adicional acerca del error
items:
$ref: '#/components/schemas/ErrorDetail'
links:
type: object
additionalProperties:
type: string
description: >-
Un mapa de nombres de enlaces a las URI asociadas que contienen
documentación sobre el error o los pasos recomendados para
solucionarlo
message:
type: string
description: >-
Un mensaje legible en el que se describa el error y los pasos para
solucionarlo, si procede
example: An error occurred
subCategory:
type: string
description: >-
Una categoría específica que contiene detalles más concretos acerca
del error
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
CollectionResponsePublicCampaignAsset:
required:
- results
type: object
properties:
paging:
$ref: '#/components/schemas/Paging'
results:
type: array
description: >-
Un conjunto de recursos de campaña pública. Cada elemento del
conjunto es un objeto que representa un recurso de campaña.
items:
$ref: '#/components/schemas/PublicCampaignAsset'
PublicBusinessUnit:
required:
- id
type: object
properties:
id:
type: integer
description: >-
El identificador único de la unidad de negocio, representado como un
entero.
format: int64
ErrorDetail:
required:
- message
type: object
properties:
code:
type: string
description: El código de estado asociado al detalle del error
context:
type: object
additionalProperties:
type: array
items:
type: string
description: Contexto de la condición de error
example: '{missingScopes=[scope1, scope2]}'
in:
type: string
description: El nombre del campo o parámetro en el que se encontró el error.
message:
type: string
description: >-
Un mensaje legible en el que se describa el error y los pasos para
solucionarlo, si procede
subCategory:
type: string
description: >-
Una categoría específica que contiene detalles más concretos acerca
del error
Paging:
type: object
properties:
next:
$ref: '#/components/schemas/NextPage'
prev:
$ref: '#/components/schemas/PreviousPage'
PublicCampaignAsset:
required:
- id
type: object
properties:
id:
type: string
description: El identificador único del recurso de la campaña.
metrics:
type: object
additionalProperties:
type: number
description: >-
Una colección de métricas asociadas con el recurso de la campaña,
representadas como pares clave-valor.
name:
type: string
description: El nombre del recurso de la campaña.
NextPage:
required:
- after
type: object
properties:
after:
type: string
description: >-
Un token de cadena que se usa como cursor para obtener la siguiente
página de resultados.
link:
type: string
description: >-
Una URL que proporciona el enlace a la siguiente página de
resultados.
description: >-
Specifies the paging information needed to retrieve the next set of
results in a paginated API response
PreviousPage:
required:
- before
type: object
properties:
before:
type: string
description: >-
Un token de cadena que indica la posición en la lista antes de la
página actual de resultados.
link:
type: string
description: >-
Una cadena que contiene el enlace URL a la página de resultados
anterior.
description: >-
specifies the paging information needed to retrieve the previous set of
results in a paginated API 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.full.read: ''
marketing.campaigns.revenue.read: ''
marketing.campaigns.write: ''
````
{product.name} -
{product.level}
)}