---
title: "List Campaign"
method: GET
path: "/Campaign"
tags: ["Campaign"]
---

# List Campaign

`GET /Campaign`

List Campaign records.

## Query parameters

- `offset` integer
- `maxSize` integer
- `orderBy` string
- `order` 'asc' | 'desc'
- `textFilter` string
- `primaryFilter` 'active'
- `boolFilterList` string[]
- `attributeSelect` string[]
- `whereGroup` WhereItem[]
  - `type` 'and' | 'or' | 'not' | 'subQueryNotIn' | 'subQueryIn' | 'expression' | 'in' | 'notIn' | 'equals' | 'notEquals' | 'on' | 'notOn' | 'like' | 'notLike' | 'startsWith' | 'endsWith' | 'contains' | 'notContains' | 'greaterThan' | 'lessThan' | 'greaterThanOrEquals' | 'lessThanOrEquals' | 'after' | 'before' | 'between' | 'ever' | 'any' | 'none' | 'isNull' | 'isNotNull' | 'isTrue' | 'isFalse' | 'today' | 'past' | 'future' | 'lastSevenDays' | 'lastXDays' | 'nextXDays' | 'olderThanXDays' | 'afterXDays' | 'currentMonth' | 'nextMonth' | 'lastMonth' | 'currentQuarter' | 'lastQuarter' | 'currentYear' | 'lastYear' | 'currentFiscalYear' | 'lastFiscalYear' | 'currentFiscalQuarter' | 'lastFiscalQuarter' | 'arrayAnyOf' | 'arrayNoneOf' | 'arrayAllOf' | 'arrayIsEmpty' | 'arrayIsNotEmpty' | 'linkedWith' | 'notLinkedWith' | 'linkedWithAll' | 'isLinked' | 'isNotLinked', required — An operator.
  - `attribute` string — An attribute or field.
  - `value` union — A value. A scalar, or an array of strings.
    - WhereItem[]
    - string[]
  - `dateTime` boolean — Set true for date-time fields.
  - `timeZone` string — A time zone. For date-time fields.

## Headers

- `X-No-Total` 'true' | 'false'

## Response `200`

Success.

- object
  - `list` Campaign[] — Records.
    - `id` string — An ID.
    - `name` string — A one-line string.
    - `status` 'Planning' | 'Active' | 'Inactive' | 'Complete'
    - `type` 'Email' | 'Newsletter' | 'Informational Email' | 'Web' | 'Television' | 'Radio' | 'Mail'
    - `startDate` string, date, nullable — A date.
    - `endDate` string, date, nullable — A date.
    - `description` string, nullable — A multi-line text.
    - `createdAt` string, nullable — A timestamp in UTC.
    - `modifiedAt` string, nullable — A timestamp in UTC.
    - `createdById` string, nullable — An ID of the record of the User type.
    - `createdByName` string, nullable — A foreign record name.
    - `modifiedById` string, nullable — An ID of the record of the User type.
    - `modifiedByName` string, nullable — A foreign record name.
    - `assignedUserId` string, nullable — An ID of the record of the User type.
    - `assignedUserName` string, nullable — A foreign record name.
    - `teamsIds` string[], nullable — IDs of records of the Team type.
    - `teamsNames` object, nullable — An {ID => record name} map.
    - `targetListsIds` string[], nullable — IDs of records of the TargetList type.
    - `targetListsNames` object, nullable — An {ID => record name} map.
    - `excludingTargetListsIds` string[], nullable — IDs of records of the TargetList type.
    - `excludingTargetListsNames` object, nullable — An {ID => record name} map.
    - `sentCount` integer, nullable
    - `openedCount` integer, nullable
    - `clickedCount` integer, nullable
    - `optedInCount` integer, nullable
    - `optedOutCount` integer, nullable
    - `bouncedCount` integer, nullable
    - `hardBouncedCount` integer, nullable
    - `softBouncedCount` integer, nullable
    - `leadCreatedCount` integer, nullable
    - `revenue` number, nullable — A currency amount.
    - `revenueCurrency` 'USD' | 'EUR', nullable — A code.
    - `budget` number, nullable — A currency amount.
    - `budgetCurrency` 'USD' | 'EUR', nullable — A code.
    - `contactsTemplateId` string, nullable — An ID of the record of the Template type.
    - `contactsTemplateName` string, nullable — A foreign record name.
    - `leadsTemplateId` string, nullable — An ID of the record of the Template type.
    - `leadsTemplateName` string, nullable — A foreign record name.
    - `accountsTemplateId` string, nullable — An ID of the record of the Template type.
    - `accountsTemplateName` string, nullable — A foreign record name.
    - `usersTemplateId` string, nullable — An ID of the record of the Template type.
    - `usersTemplateName` string, nullable — A foreign record name.
    - `mailMergeOnlyWithAddress` boolean
    - `revenueConverted` number, nullable — A currency amount converted to the default currency.
    - `budgetConverted` number, nullable — A currency amount converted to the default currency.
  - `total` number — The total number of records. If the total number is disabled, special values are returned: -1 – there are more records to paginate, -2 – there are no more records.

## Other responses

- `400` — Bad request. Check logs for details.
- `403` — Forbidden. Might be an access control error. Check logs for details.

---

[API](https://skmtc.net/espocrm/apis/espocrm-api.md) · [All operations](https://skmtc.net/espocrm/apis/espocrm-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/espocrm/espocrm-api/versions/6622dabfccd3/schema)