> ## Documentation Index
> Fetch the complete documentation index at: https://developers.hubspot.de/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get campaigns

> Dieser Endpunkt liest einen Batch mit Kampagnen basierend auf den angegebenen Eingabedaten und gibt die Kampagnen zusammen mit den zugeordneten Elementen zurück. 
Die maximale Anzahl von Elementen in einer Batch-Anfrage beträgt 50.
Die Kampagnen in der Antwort müssen nicht in der gleichen Reihenfolge wie in der Anfrage angegeben sein.
Wenn in der Anfrage doppelte Kampagnen-IDs angegeben werden, werden die Duplikate ignoriert. Die Antwort enthält nur eindeutige IDs und wird ohne Duplikate zurückgegeben.


export const ScopesList = ({scopes = [], description = "Diese API erfordert einen der folgenden Bereiche:"}) => {
  if (!scopes || scopes.length === 0) {
    return null;
  }
  const sortedScopes = scopes.sort((a, b) => a.localeCompare(b));
  return <div>
      <div className="text-sm mb-2">{description}</div>
      <div>
        {sortedScopes.map((scope, index) => <div key={index}>
            <code>
              <span className="text-xs">{scope}</span>
            </code>
          </div>)}
      </div>
    </div>;
};

export const SupportedProducts = ({marketing, sales, service, cms, marketingLevel, salesLevel, serviceLevel, cmsLevel}) => {
  const translations = {
    header: "Unterstützte Produkte",
    description: "Erfordert eines der folgenden Produkte oder höher.",
    productNames: {
      marketing: "Marketing Hub",
      sales: "Sales Hub",
      service: "Service Hub",
      cms: "Content Hub"
    },
    tiers: {
      free: "Kostenlos",
      starter: "Starter",
      professional: "Professional",
      enterprise: "Enterprise"
    }
  };
  const translateTier = tier => {
    if (!tier) return '';
    const lowerTier = tier.toLowerCase();
    return translations.tiers[lowerTier] || tier;
  };
  const products = [{
    name: marketing ? translations.productNames.marketing : '',
    level: translateTier(marketingLevel),
    icon: "https://mintlify-assets.b-cdn.net/Icons/marketing-bolt.svg",
    alt: "Marketing Hub"
  }, {
    name: sales ? translations.productNames.sales : '',
    level: translateTier(salesLevel),
    icon: "https://mintlify-assets.b-cdn.net/Icons/sales-star.svg",
    alt: "Sales Hub"
  }, {
    name: service ? translations.productNames.service : '',
    level: translateTier(serviceLevel),
    icon: "https://mintlify-assets.b-cdn.net/Icons/service-heart.svg",
    alt: "Service Hub"
  }, {
    name: cms ? translations.productNames.cms : '',
    level: translateTier(cmsLevel),
    icon: "https://mintlify-assets.b-cdn.net/Icons/content-play.svg",
    alt: "Content Hub"
  }].filter(product => product.name && product.level);
  if (products.length === 0) return null;
  return <div>
      <div className="text-sm mb-2">{translations.description}</div>
      <div className={`grid ${products.length === 1 ? 'grid-cols-1' : 'grid-cols-2'} gap-1.5`}>
        {products.map((product, index) => <div key={index} style={{
    display: 'flex',
    alignItems: 'center'
  }}>
            <img src={product.icon} alt={product.alt} className="w-3.5 h-3.5 mr-1.5 mt-2.5 mb-2.5 flex-shrink-0 align-middle" />
            <span className="font-medium mr-1 text-sm">{product.name} -</span>
            <span className="text-sm">{product.level}</span>
          </div>)}
      </div>
    </div>;
};

<AccordionGroup>
  <Accordion title="Supported products" defaultOpen="true" icon="cubes">
    <SupportedProducts marketing={true} sales={true} service={true} cms={true} marketingLevel="PROFESSIONAL" salesLevel="FREE" serviceLevel="FREE" cmsLevel="FREE" />
  </Accordion>

  <Accordion title="Required Scopes" icon="key">
    <ScopesList
      scopes={[
  'marketing.campaigns.read'
]}
    />
  </Accordion>
</AccordionGroup>


## OpenAPI

````yaml specs/legacy/v3/marketing-campaigns-public-api-v3.json POST /marketing/v3/campaigns/batch/read
openapi: 3.0.1
info:
  title: Marketing Campaigns Public Api
  description: Basepom for all HubSpot Projects
  version: v3
  x-hubspot-product-tier-requirements:
    marketing: PROFESSIONAL
    sales: FREE
    service: FREE
    cms: FREE
    commerce: FREE
    crmHub: FREE
    dataHub: FREE
  x-hubspot-related-documentation:
    - name: Campaigns
      url: https://developers.hubspot.com/docs/guides/api/marketing/campaigns
servers:
  - url: https://api.hubapi.com
security: []
tags:
  - name: Assets
  - name: Basic
  - name: Batch
  - name: Budget
  - name: Metrics
  - name: Spend
paths:
  /marketing/v3/campaigns/batch/read:
    post:
      tags:
        - Batch
      summary: Einen Batch mit Kampagnen lesen
      description: >
        Dieser Endpunkt liest einen Batch mit Kampagnen basierend auf den
        angegebenen Eingabedaten und gibt die Kampagnen zusammen mit den
        zugeordneten Elementen zurück. 

        Die maximale Anzahl von Elementen in einer Batch-Anfrage beträgt 50.

        Die Kampagnen in der Antwort müssen nicht in der gleichen Reihenfolge
        wie in der Anfrage angegeben sein.

        Wenn in der Anfrage doppelte Kampagnen-IDs angegeben werden, werden die
        Duplikate ignoriert. Die Antwort enthält nur eindeutige IDs und wird
        ohne Duplikate zurückgegeben.
      operationId: post-/marketing/v3/campaigns/batch/read
      parameters:
        - name: endDate
          in: query
          description: >-
            Enddatum für das Abrufen von Kennzahlen für Elemente, formatiert als
            JJJJ-MM-TT. Dieses Datum wird verwendet, um die den Inhaltselementen
            zugeordneten Kennzahlen für einen bestimmten Zeitraum abzurufen.
            Falls nicht angegeben, werden keine Kennzahlen für Elemente
            abgerufen.

            Beispiel: 2024-01-27
          required: false
          style: form
          explode: true
          schema:
            type: string
        - name: properties
          in: query
          description: >-
            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.

            Beispiel: hs_name, hs_campaign_status, hs_notes
          required: false
          style: form
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: startDate
          in: query
          description: >-
            Startdatum für das Abrufen von Kennzahlen für Elemente, formatiert
            als JJJJ-MM-TT. Dieses Datum wird verwendet, um die den
            Inhaltselementen zugeordneten Kennzahlen für einen bestimmten
            Zeitraum abzurufen. Falls nicht angegeben, werden keine Kennzahlen
            für Elemente abgerufen.

            Beispiel: 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: >-
            Ein Array von PublicCampaignReadInput-Objekten, die jeweils die ID
            einer zu lesenden Kampagne enthalten. Diese Eigenschaft ist
            erforderlich.
          items:
            $ref: '#/components/schemas/PublicCampaignReadInput'
    BatchResponsePublicCampaignWithAssets:
      required:
        - completedAt
        - results
        - startedAt
        - status
      type: object
      properties:
        completedAt:
          type: string
          description: >-
            Der Zeitstempel, wann die Verarbeitung der Batch-Anfrage
            abgeschlossen wurde.
          format: date-time
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            Eine Sammlung von URLs, die mit zugehörigen Ressourcen oder
            Dokumentationen verknüpft sind.
        requestedAt:
          type: string
          description: Der Zeitstempel, wann die Batch-Anfrage ursprünglich gestellt wurde.
          format: date-time
        results:
          type: array
          description: >-
            Ein Array von Ergebnissen des Batch-Vorgangs, wobei jedes Element
            eine öffentliche Kampagne mit Assets darstellt.
          items:
            $ref: '#/components/schemas/PublicCampaignWithAssets'
        startedAt:
          type: string
          description: >-
            Der Zeitstempel, wann die Verarbeitung der Batch-Anfrage begonnen
            hat.
          format: date-time
        status:
          type: string
          description: >-
            Der aktuelle Verarbeitungsstatus des Batch-Vorgangs mit den
            möglichen Werten: CANCELED, COMPLETE, PENDING, PROCESSING.
          enum:
            - CANCELED
            - COMPLETE
            - PENDING
            - PROCESSING
    BatchResponsePublicCampaignWithAssetsWithErrors:
      required:
        - completedAt
        - results
        - startedAt
        - status
      type: object
      properties:
        completedAt:
          type: string
          description: >-
            Der Zeitpunkt (Datum und Uhrzeit), zu dem der Batch-Vorgang
            abgeschlossen wurde.
          format: date-time
        errors:
          type: array
          description: "Die Liste der Fehler für einzelne Kampagnenlesevorgänge, die innerhalb des Batches fehlgeschlagen sind (z.\_B. Kampagne nicht gefunden, Berechtigung verweigert). Nur enthalten, wenn nicht leer.  "
          items:
            $ref: '#/components/schemas/StandardError'
        links:
          type: object
          additionalProperties:
            type: string
          description: Eine Sammlung von Links im Zusammenhang mit dem Batch-Vorgang.
        numErrors:
          type: integer
          description: Die Anzahl der während des Batch-Vorgangs aufgetretenen Fehler.
          format: int32
        requestedAt:
          type: string
          description: >-
            Der Zeitpunkt (Datum und Uhrzeit), zu dem der Batch-Vorgang
            angefordert wurde.
          format: date-time
        results:
          type: array
          description: >-
            Die Liste der erfolgreich abgerufenen Kampagnen mit den zugehörigen
            Elementen.
          items:
            $ref: '#/components/schemas/PublicCampaignWithAssets'
        startedAt:
          type: string
          description: >-
            Der Zeitpunkt (Datum und Uhrzeit), zu dem der Batch-Vorgang
            gestartet wurde.
          format: date-time
        status:
          type: string
          description: >-
            Der aktuelle Status des Batch-Vorgangs mit folgenden möglichen
            Werten: CANCELED, COMPLETE, PENDING oder PROCESSING.
          enum:
            - CANCELED
            - COMPLETE
            - PENDING
            - PROCESSING
    PublicCampaignReadInput:
      required:
        - id
      type: object
      properties:
        id:
          type: string
          description: Die eindeutige ID für eine Kampagne.
    PublicCampaignWithAssets:
      required:
        - assets
        - businessUnits
        - createdAt
        - id
        - properties
        - updatedAt
      type: object
      properties:
        assets:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/CollectionResponsePublicCampaignAsset'
          description: >-
            Enthält die Elemente, die der Kampagne zugeordnet sind, jeweils
            dargestellt als Sammlung von Kampagnenelementen.
        businessUnits:
          type: array
          description: >-
            Ein Array von Unternehmensbereichen, das der Kampagne zugeordnet
            ist. Jedes Element wird durch ein PublicBusinessUnit-Objekt
            dargestellt.
          items:
            $ref: '#/components/schemas/PublicBusinessUnit'
        createdAt:
          type: string
          description: >-
            Der Zeitpunkt (Datum und Uhrzeit), zu dem die Kampagne erstellt
            wurde, formatiert als datetime-Zeichenfolge.
          format: date-time
        id:
          type: string
          description: Die eindeutige ID für die Kampagne.
        properties:
          type: object
          additionalProperties:
            type: string
          description: >-
            Eine Karte an Schlüssel-Wert-Paaren, die Eigenschaften für diese
            Kampagne darstellen.
        updatedAt:
          type: string
          description: >-
            Der Zeitpunkt (Datum und Uhrzeit), zu dem die Kampagne zuletzt
            aktualisiert wurde, formatiert als datetime-Zeichenfolge.
          format: date-time
    StandardError:
      required:
        - category
        - context
        - errors
        - links
        - message
        - status
      type: object
      properties:
        category:
          type: string
          description: Die Hauptkategorie des Fehlers.
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: >-
            Zusätzliche kontextspezifische Informationen, die sich auf den
            Fehler beziehen.
        errors:
          type: array
          description: Die ausführlichen Fehlerobjekte.
          items:
            $ref: '#/components/schemas/ErrorDetail'
        id:
          type: string
          description: Eine eindeutige ID der Fehlerinstanz.
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            URLs, die mit der Dokumentation oder dem Fehler zugeordnete
            Ressourcen verknüpft sind.
        message:
          type: string
          description: >-
            Eine für Menschen lesbare Zeichenfolge mit einer Beschreibung des
            Fehlers und möglichen Abhilfemaßnahmen.
        status:
          type: string
          description: Der HTTP-Statuscode, der dem Fehler zugeordnet ist.
        subCategory:
          type: object
          properties: {}
          description: >-
            Eine spezifischere Fehlerkategorie innerhalb der jeweiligen
            Hauptkategorie.
      description: >-
        Stellt eine Standard-Fehlerantwort in der HubSpot-API dar, die
        detaillierte Informationen über einen Fehler bereitstellt, der während
        einer API-Anfrage aufgetreten ist.
    Error:
      required:
        - category
        - correlationId
        - message
      type: object
      properties:
        category:
          type: string
          description: Die Fehlerkategorie
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Kontext zur Fehlerbedingung
          example: >-
            {invalidPropertyName=[propertyValue], missingScopes=[scope1,
            scope2]}
        correlationId:
          type: string
          description: >-
            Eine eindeutige ID für die Anfrage. Berücksichtigen Sie diesen Wert
            in Fehlerberichten oder Support-Tickets.
          format: uuid
          example: aeb5f871-7f07-4993-9211-075dc63e7cbf
        errors:
          type: array
          description: Weitere Informationen zum Fehler
          items:
            $ref: '#/components/schemas/ErrorDetail'
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            Eine Zuordnung der Namen von Links zu zugeordneten URIs mit einer
            Dokumentation zum Fehler oder empfohlenen Abhilfemaßnahmen
        message:
          type: string
          description: >-
            Eine für Menschen lesbare Nachricht mit einer Beschreibung des
            Fehlers und ggf. Abhilfemaßnahmen
          example: An error occurred
        subCategory:
          type: string
          description: Eine spezifische Kategorie, die genauere Details zum Fehler enthält
      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: >-
            Ein Array von öffentlichen Kampagnenelementen. Jedes Element im
            Array ist eine Referenz für ein PublicCampaignAsset-Objekt.
          items:
            $ref: '#/components/schemas/PublicCampaignAsset'
    PublicBusinessUnit:
      required:
        - id
      type: object
      properties:
        id:
          type: integer
          description: >-
            Die eindeutige ID für den Unternehmensbereich, dargestellt als
            Ganzzahl.
          format: int64
    ErrorDetail:
      required:
        - message
      type: object
      properties:
        code:
          type: string
          description: Der Statuscode, der dem Fehlerdetail zugeordnet ist
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Kontext zur Fehlerbedingung
          example: '{missingScopes=[scope1, scope2]}'
        in:
          type: string
          description: >-
            Der Name des Felds oder Parameters, in dem der Fehler gefunden
            wurde.
        message:
          type: string
          description: >-
            Eine für Menschen lesbare Nachricht mit einer Beschreibung des
            Fehlers und ggf. Abhilfemaßnahmen
        subCategory:
          type: string
          description: Eine spezifische Kategorie, die genauere Details zum Fehler enthält
    Paging:
      type: object
      properties:
        next:
          $ref: '#/components/schemas/NextPage'
        prev:
          $ref: '#/components/schemas/PreviousPage'
    PublicCampaignAsset:
      required:
        - id
      type: object
      properties:
        id:
          type: string
          description: Die eindeutige ID für das Kampagnenelement.
        metrics:
          type: object
          additionalProperties:
            type: number
          description: >-
            Eine Sammlung an Kennzahlen, die dem Kampagnenelement zugeordnet
            sind, dargestellt als Schlüssel-Wert-Paare.
        name:
          type: string
          description: Der Name des Kampagnenelements.
    NextPage:
      required:
        - after
      type: object
      properties:
        after:
          type: string
          description: Ein Paginierungscursor-Token zum Abrufen nachfolgender Seiten.
        link:
          type: string
          description: Eine URL zum Abrufen der Ergebnisse auf der nächsten Seite.
      description: >-
        Gibt die Seitennummerierungsinformationen an, die zum Abrufen der
        nächsten Ergebnisse in einer seitennummerierten API-Antwort erforderlich
        sind
    PreviousPage:
      required:
        - before
      type: object
      properties:
        before:
          type: string
          description: Ein Paginierungscursor-Token zum Abrufen vorheriger Seiten.
        link:
          type: string
          description: Eine URL zum Abrufen der Ergebnisse auf den vorherigen Seiten.
      description: >-
        Gibt die Seitennummerierungsinformationen an, die zum Abrufen der
        vorherigen Ergebnisse in einer seitennummerierten API-Antwort
        erforderlich sind
  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: ''

````