Retrieve a campaign

Ruft eine Kampagne ab, die durch eine bestimmte campaignGuid mit den angegebenen Eigenschaften identifiziert wird. Zusammen mit den Kampagneninformationen werden außerdem Informationen zu Elementen zurückgegeben. Abhängig von den verwendeten Abfrageparametern können ggf. auch Informationen über die zugeordneten Kennzahlen für Elemente abgerufen werden. Kennzahlen sind nur verfügbar, wenn startDate und endDate angegeben werden.

GET /marketing/campaigns/2026-03/{campaignGuid}

Eine Kampagne lesen

cURL

curl --request GET \
  --url https://api.hubapi.com/marketing/campaigns/2026-03/{campaignGuid} \
  --header 'Authorization: Bearer <token>'

200

{
  "assets": {},
  "businessUnits": [
    {
      "id": 123
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "properties": {},
  "updatedAt": "2023-11-07T05:31:56Z"
}

Supported products

Required Scopes

Autorisierungen

Authorization · string · header · erforderlich

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

Pfadparameter

campaignGuid · string · erforderlich

Die UUID der Kampagne, erforderlich Beispiel: 9dbec438-53e2-4b28-8c0f-38f56574a6e8

Abfrageparameter

endDate · string

Das Enddatum für das Abrufen von Kennzahlen für Elemente im Format JJJJ-MM-TT. Optional. Beispiel: 2000-01-27

properties · string[]

Eine durch Kommas getrennte Liste von Eigenschaften, die in die Antwort aufgenommen werden sollen. Nicht erkannte Eigenschaften werden ignoriert. Optional. Beispiel: hs_name,hs_budget, hs_notes

startDate · string

Das Startdatum für das Abrufen von Kennzahlen für Elemente im Format JJJJ-MM-TT.
Optional. Beispiel: 2000-01-20

Antwort

200

application/json

successful operation

assets · object · erforderlich

Enthält die Elemente, die der Kampagne zugeordnet sind, jeweils dargestellt als Sammlung von Kampagnenelementen.

Show child attributes

businessUnits · object[] · erforderlich

Ein Array von Unternehmensbereichen, das der Kampagne zugeordnet ist. Jedes Element wird durch ein PublicBusinessUnit-Objekt dargestellt.

Show child attributes

createdAt · string<date-time> · erforderlich

Der Zeitpunkt (Datum und Uhrzeit), zu dem die Kampagne erstellt wurde, formatiert als datetime-Zeichenfolge.

id · string · erforderlich

Die eindeutige ID für die Kampagne.

properties · object · erforderlich

Eine Karte an Schlüssel-Wert-Paaren, die Eigenschaften für diese Kampagne darstellen.

Show child attributes

updatedAt · string<date-time> · erforderlich

Der Zeitpunkt (Datum und Uhrzeit), zu dem die Kampagne zuletzt aktualisiert wurde, formatiert als datetime-Zeichenfolge.