GET
/
marketing
/
v3
/
campaigns
/
Kampagnensuche
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"
    }
  ]
}
Unterstützte Produkte
Erfordert eines der folgenden Produkte oder höher.
Marketing HubMarketing HubProfessional
Sales HubSales HubKostenlos
Service HubService HubKostenlos
Content HubContent HubKostenlos

Erforderliche Bereiche

Diese API erfordert einen der folgenden Bereiche:
  • 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

Das Feld, nach dem die Ergebnisse sortiert werden sollen. Zulässige Werte sind hs_name, createdAt, updatedAt. Durch ein „-“ vor dem Eigenschaftsnamen kann eine absteigende Reihenfolge festgelegt werden. Standardwert: hs_name

after
string

Ein Cursor für die Seitennummerierung. Soweit angegeben, beginnen die Ergebnisse nach dem angegebenen Cursor. Beispiel: NTI1Cg%3D%3D

limit
integer

Die maximale Anzahl der Ergebnisse, die zurückgegeben werden. Zulässiger Wertebereich: 1 bis 100 Standardwert: 50

name
string

Ein Filter, der Kampagnen zurückgibt, deren Namen die angegebene Teilzeichenfolge enthalten. Dies ermöglicht einen teilweisen Abgleich von Kampagnennamen und es werden alle Kampagnen zurückgegeben, die die angegebene Teilzeichenfolge in ihrem Namen enthalten. Wird dieser Parameter nicht angegeben, gibt die Suche alle Kampagnen zurück.

properties
string[]

Eine durch Kommas getrennte Liste der Eigenschaften, die in der Antwort zurückgegeben werden sollen. Wenn eine der angegebenen Eigenschaften keinen Wert für das/die angeforderte(n) Objekt(e) aufweist (Wert ist leer), wird sie ignoriert und nicht in der Antwort zurückgegeben. Wenn dieser Parameter leer ist, enthält die Antwort eine leere Eigenschaftszuordnung.

Response

successful operation

The response is of type object.