---
title: "GET /campaign"
method: GET
path: "/campaign"
tags: ["campaign"]
---

# GET /campaign

`GET /campaign`

## Request

- Base URL: `https://www.weclapp.com/api/nullapi/v2`
- URL: `https://www.weclapp.com/api/nullapi/v2/campaign`
- Auth: API key in header `AuthenticationToken`
- TypeScript: <https://skmtc.dev/weclapp/apis/weclapp-api/docs/campaign/get.ts> (a function with typed inputs; its response is checked against the schema)

query campaign

## Query parameters

- `page` integer
- `pageSize` integer
- `sort` string

## Response `200`

campaign response

- object
  - `result` Campaign[]
    - `id` string
    - `version` string
    - `campaignEndDate` integer
    - `campaignName` string, required
    - `campaignNumber` string
    - `campaignStartDate` integer
    - `campaignType` 'ADVERTISEMENT' | 'BULKMAIL' | 'EMAIL' | 'EVENT' | 'EXPOSITION' | 'FAIR' | 'OTHER' | 'PUBLICRELATION' | 'TELEMARKETING' | 'WEBINAR'
    - `createdDate` integer
    - `customAttributes` CustomAttribute[]
      - `attributeDefinitionId` string
      - `booleanValue` boolean
      - `dateValue` integer
      - `entityId` string
      - `entityReferences` EntityReference[]
        - `entityId` string
        - `entityName` string
      - `numberValue` string, number
      - `selectedValueId` string
      - `selectedValues` OnlyId[]
        - `id` string
      - `stringValue` string
    - `description` string
    - `lastModifiedDate` integer
    - `responsibleUserId` string

## Other responses

- `default`: error response

---

[API](https://skmtc.dev/weclapp/apis/weclapp-api.md) - [All operations](https://skmtc.dev/weclapp/apis/weclapp-api/llms.txt) - [OpenAPI document](https://skmtc.dev/weclapp/apis/weclapp-api/revisions/0e021229755d?raw)