Zum Hauptinhalt springen
GET
/
marketing
/
v3
/
campaigns
/
Recherche de campagnes
curl --request GET \
  --url https://api.hubapi.com/marketing/v3/campaigns/ \
  --header 'Authorization: Bearer <token>'
{
  "total": 123,
  "paging": {
    "next": {
      "link": "",
      "after": ""
    }
  },
  "results": [
    {
      "createdAt": "2023-11-07T05:31:56Z",
      "businessUnits": [
        {
          "id": 123
        }
      ],
      "id": "<string>",
      "properties": {},
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Produits pris en charge

Exige l'un des produits suivants ou un produit supérieur.
Marketing HubMarketing Hub -Pro
Sales HubSales Hub -Gratuit
Service HubService Hub -Gratuit
Content HubContent Hub -Gratuit
Cette API requiert l'une des portées suivantes :
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

Le champ par lequel trier les résultats. Les valeurs autorisées sont hs_name, createdAt, updatedAt. Un « - » optionnel avant le nom de la propriété peut indiquer un ordre décroissant Par défaut : hs_name

​
after
string

Un curseur pour la pagination. Si fournis, les résultats commenceront après le curseur donné. Exemple : NTI1Cg%3D%3D

​
limit
integer

Le nombre maximum de résultats à afficher. Les valeurs autorisées vont de 1 à 100 Par défaut : 50

​
name
string

Un filtre pour afficher les campagnes dont les noms contiennent la sous-chaîne spécifiée. Cela permet une correspondance partielle des noms de campagnes, affichant toutes les campagnes qui incluent la sous-chaîne donnée dans leur nom. Si ce paramètre n'est pas fourni, la recherche affichera toutes les campagnes

​
properties
string[]

Une liste de propriétés, séparées par des virgules, à afficher dans la réponse. Si l'une des propriétés spécifiées a une valeur vide sur l'objet/les objets demandé(s), elle sera ignorée et ne sera pas affichée dans la réponse. Si ce paramètre est vide, la réponse inclura une carte de propriétés vide

Response

successful operation

​
total
integer
required
​
results
object[]
required
​
paging
object
⌘I