Skip to main content
GET
/
marketing
/
v3
/
campaigns
/
Búsqueda de campañas
curl --request GET \
  --url https://api.hubapi.com/marketing/v3/campaigns/ \
  --header 'Authorization: Bearer <token>'
{
  "total": 123,
  "paging": {
    "next": {
      "link": "<string>",
      "after": "<string>"
    }
  },
  "results": [
    {
      "createdAt": "2023-11-07T05:31:56Z",
      "businessUnits": [
        {
          "id": 123
        }
      ],
      "id": "<string>",
      "properties": {},
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Productos compatibles

Se requiere uno de los siguientes productos o productos de ediciones superiores.
Marketing HubMarketing Hub -Pro
Sales HubSales Hub -Gratuito
Service HubService Hub -Gratuito
Content HubContent Hub -Gratuito
Esta API requiere uno de los siguientes ámbitos:
marketing.campaigns.read

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

sort
string

El campo por el cual ordenar los resultados. Los valores permitidos son hs_name, createdAt, updatedAt. Un "-" opcional antes del nombre de la propiedad puede denotar orden descendente Predeterminado: hs_name

after
string

Un cursor para la paginación. Si se proporciona, los resultados comenzarán después del cursor dado. Ejemplo: NTI1Cg%3D%3D

limit
integer

El número máximo de resultados que se devolverán. Valores permitidos entre 1 y 100 Predeterminado: 50

name
string

Un filtro para devolver campañas cuyos nombres contengan la subcadena especificada. Esto permite la coincidencia parcial de nombres de campañas, y se devuelven todas las campañas que incluyan la subcadena dada en su nombre. Si no se proporciona este parámetro, la búsqueda mostrará todas las campañas

properties
string[]

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, serán ignoradas y no se mostrarán en la respuesta. Si este parámetro está vacío, la respuesta incluirá un mapa de propiedades vacío.

Response

successful operation

total
integer
required
results
object[]
required
paging
object