---
title: "Retrieve list of all campaigns"
method: POST
path: "/v3/campaigns"
tags: ["Campaign"]
---

# Retrieve list of all campaigns

`POST /v3/campaigns`

This endpoint retrieves a list of campaigns based on specified filters and parameters such as campaign name, campaign type, placement ID, team ID, approval state, and more. A date range (from and to) can be provided to narrow results based on the updateTime of the campaign. Pagination and sorting are supported to manage large datasets efficiently.

## Request body

- V3ListCampaignsRequest
  - `filters` V3ListCampaignFilters
    - `pageToken` string — Pagination token to retrieve the next page of results.
    - `pageSize` string, int64 — The pageSize specifies the number of campaigns to retrieve per page. Only positive integers up to 1000 are allowed. If a value greater than 1000 is provided, an error will be returned.
    - `sortOptions` V3ListCampaignFiltersSortOption
      - `key` 'SORT_OPTION_KEY_UPDATE_TIME' | 'SORT_OPTION_KEY_NAME' | 'SORT_OPTION_KEY_END_TIME' | 'SORT_OPTION_KEY_APPROVAL_STATE' | 'SORT_OPTION_KEY_CAMPAIGN_STATE'
      - `order` 'SORT_OPTION_ORDER_ASC' | 'SORT_OPTION_ORDER_DESC'
      - `lastValue` string — The lastValue is used to retrieve the subsequent set of results on the next page. It must not be included in the request body.
    - `name` string — Filter campaigns by the specified name.
    - `placementId` string — Filter campaigns using specified placement IDs. You can include up to 50 placement IDs in your request.
    - `teamId` string — Filter campaigns by the specified team ID.
    - `approvalState` string — Filter campaigns by the specified approval state. You can use APPROVAL_STATE_PENDING, APPROVAL_STATE_APPROVED, or APPROVAL_STATE_REJECTED. You can include one or more approval states.
    - `campaignState` string — Filter campaigns by the specified campaign state. You can use CAMPAIGN_STATE_ACTIVE, CAMPAIGN_STATE_PAUSED, CAMPAIGN_STATE_DRAFT, or CAMPAIGN_STATE_ARCHIVED. You can include one or more campaign states.
    - `catalogIds` string[] — Filter campaigns by one or more catalog IDs. Multiple catalog IDs can be specified.
    - `managedOnly` boolean — Filter campaigns to only include those that are retailer-managed, such as fixed tenancy.
    - `requestTeamId` string, required — The ID of the team requesting campaigns. Retailers use their team ID to list campaigns across multiple teams, while advertisers use their own team ID.
    - `walletId` string — Filter campaigns using specified wallet IDs. You can include up to 50 wallet IDs in your request.
    - `campaignType` string — List campaigns by different campaign file types, such as BannerX, Product, Banner and Brand page.
    - `ids` string[] — Filter campaigns using specified campaign IDs. Up to 50 campaign IDs can be included in the request, separated by commas.
    - `fromDate` string, date-time — Specifies the start timestamp for retrieving campaigns. Provide the time in ISO-8601 format. If fromDate is specified, toDate must also be included.
    - `toDate` string, date-time — Specifies the end timestamp for retrieving campaigns. Provide the time in ISO-8601 format. If toDate is specified, fromDate must also be included.

## Response `200`

List of campaigns with pagination token for retrieving additional results.

- V3ListCampaignsResponse
  - `campaigns` V3Campaign[]
    - `id` string, required — The unique identifier of the campaign.
    - `updateTime` string, date-time — The last time the entity was updated.
    - `name` string — The name of the campaign.
    - `namespaceId` string — The unique identifier of the namespace.
    - `campaignState` 'CAMPAIGN_STATE_UNSPECIFIED' | 'CAMPAIGN_STATE_ACTIVE' | 'CAMPAIGN_STATE_PAUSED' | 'CAMPAIGN_STATE_DRAFT' | 'CAMPAIGN_STATE_ARCHIVED'
    - `templateId` string — The unique identifier of the campaign template.
    - `managerTeamId` string — The retailer manager teamId of the campaign. Only utilised in fixed tenancy campaigns.
    - `teamId` string — The unique identifier of the campaign's team.
    - `startTime` string, date-time — When the campaign starts as a precise ISO-8601 timestamp.
    - `endTime` string, date-time — When the campaign ends as a precise ISO-8601 timestamp. If removed then the campaign will be treated as 'ALWAYS ON'.
    - `walletId` string — The unique identifier of the wallet to be charged for the campaign.
    - `placementId` string — The unique identifier of the campaign's placement.
    - `catalogIds` string[] — The unique identifier of the retailer's catalog.
    - `advertisedProducts` Campaignv3AdvertisedProducts
      - `productsByKey` Campaignv3CatalogProductSeller[]
        - `catalogId` string — The unique identifier of the retailer's catalog.
        - `productCode` string — The product code within the catalog.
        - `sellerId` string — The seller ID for the product. Defaults to an empty string.
      - `productGroupList` string[] — The list of product group ids from Epsilon Digital
    - `targeting` Campaignv3Targeting
      - `searchTerms` Campaignv3SearchTerm[] — Used for placements that target search terms.
        - `phrase` string — The keyword you want to target in your campaign, with a maximum length of 150 characters.
        - `matchType` 'MATCH_TYPE_UNSPECIFIED' | 'MATCH_TYPE_PHRASE_MATCH' | 'MATCH_TYPE_EXACT_MATCH'
        - `collectionName` string — Used internally by Epsilon Retail Media. Omit unless advised by Epsilon Retail Media otherwise.
        - `suggested` boolean — Used internally by Epsilon Retail Media. Omit unless advised by Epsilon Retail Media otherwise.
        - `excludedProducts` Campaignv3CatalogProductSeller[] — Used internally by Epsilon Retail Media. Omit unless advised by Epsilon Retail Media otherwise.
          - `catalogId` string — The unique identifier of the retailer's catalog.
          - `productCode` string — The product code within the catalog.
          - `sellerId` string — The seller ID for the product. Defaults to an empty string.
        - `maxBid` string — The maximum cost per click bid for the search term, overriding the auction's default max bid for that term.
        - `treatAsCustom` boolean — Flag that determines whether the search term is treated as custom. Custom terms apply to all products in the campaign. This flag should only be used when the placement supports suggested search terms and allows custom terms.
      - `crossSell` Campaignv3CrossSell
        - `targetProductsByKey` Campaignv3CatalogProductSeller[]
          - `catalogId` string — The unique identifier of the retailer's catalog.
          - `productCode` string — The product code within the catalog.
          - `sellerId` string — The seller ID for the product. Defaults to an empty string.
      - `upsell` Campaignv3Upsell
        - `targetProductsByKey` Campaignv3CatalogProductSeller[]
          - `catalogId` string — The unique identifier of the retailer's catalog.
          - `productCode` string — The product code within the catalog.
          - `sellerId` string — The seller ID for the product. Defaults to an empty string.
      - `excludeFilters` Campaignv3TargetedFilter[] — Used for integrations, excluding those with the filters enabled.
        - `catalogId` string — The unique identifier of the retailer's catalog.
        - `filter` string — The product filter targeted by the campaign.
      - `includeFilters` Campaignv3TargetedFilter[] — Used for integrations, including those with the filters enabled.
        - `catalogId` string — The unique identifier of the retailer's catalog.
        - `filter` string — The product filter targeted by the campaign.
      - `negativeSearchTerms` V3NegativeSearchTerm[] — Used for placements that target search terms.
        - `phrase` string — The negative search term.
        - `matchType` 'MATCH_TYPE_UNSPECIFIED' | 'MATCH_TYPE_EXACT_MATCH' | 'MATCH_TYPE_PHRASE_MATCH'
      - `audience` V3Audience
        - `includeSegmentsSets` V3SegmentsSet[] — Segment sets used for audience targeting combined by AND operator.
          - `segmentIds` string[] — Segments used for audience targeting combined by OR operator.
    - `strategy` Campaignv3Strategy
      - `auction` Campaignv3Auction
        - `maxBid` string — The maximum cost per click for the campaign. For search targeted placements, any search term max bid defined against a search term will override the auction max bid.
        - `spendLimit` Campaignv3SpendLimit
          - `daily` string — Daily spend limit.
          - `total` string — Total spend limit.
      - `fixedTenancy` Campaignv3FixedTenancy
        - `cost` string — The cost of the campaign for reporting purposes. This value is not charged to the wallet.
        - `positions` integer[] — The fixed tenancy position booked by the campaign.
        - `catalogCosts` Campaignv3CatalogCost[]
          - `catalogId` string — The unique identifier of the retailer's catalog.
          - `catalogCostPercentage` number, float — The percentage of the campaign's cost allocated to the catalog.
    - `fixedCosts` Campaignv3FixedCosts
      - `dataCost` string — The cost associated with data for the campaign.
      - `creativeCost` string — The cost associated with creative production for the campaign.
      - `otherCost` string — The cost associated with other expenses for the campaign.
    - `customFields` Campaignv3CustomField[]
      - `customFieldId` string — The unique identifier of the custom field.
      - `content` string — The contents of the custom field.
    - `customQuestions` Campaignv3CustomQuestion[] — Used for integrations utilising custom targeting.
      - `customQuestionId` string — The ID of the custom question.
      - `answers` string[] — The selections of the advertiser relevant to the custom question.
    - `sellerId` string — The sellerId of the campaign. Defaults to empty string if null.
    - `bannerXConfig` V3BannerXConfig
      - `contentStandardId` string — The unique identifier of the content standard.
      - `slotId` string — The unique identifier of the slot.
      - `slotType` 'BANNER_X_SLOT_TYPE_UNSPECIFIED' | 'BANNER_X_SLOT_TYPE_BANNER' | 'BANNER_X_SLOT_TYPE_SINGLE_TILE' | 'BANNER_X_SLOT_TYPE_DOUBLE_TILE'
      - `headingText` string — The heading text for the banner.
      - `bannerText` string — The main text of the banner.
      - `bannerTextColourHex` string — The color of the banner text in hex format.
      - `ctaFlag` boolean — Flag indicating if the banner has a call-to-action.
      - `ctaText` string — The call-to-action text on the banner.
      - `ctaTextAccessibility` string — The call-to-action text for accessibility purposes.
      - `ctaLink` string — The URL for the call-to-action link.
      - `backgroundColourHex` string — The background color of the banner in hex format.
      - `backgroundImageId` string — The unique identifier of the background image.
      - `backgroundImagePosition` 'BANNER_X_BACKGROUND_IMAGE_POSITION_UNSPECIFIED' | 'BANNER_X_BACKGROUND_IMAGE_POSITION_REPEATING' | 'BANNER_X_BACKGROUND_IMAGE_POSITION_LEFTALIGNED' | 'BANNER_X_BACKGROUND_IMAGE_POSITION_RIGHTALIGNED' | 'BANNER_X_BACKGROUND_IMAGE_POSITION_TOPALIGNED' | 'BANNER_X_BACKGROUND_IMAGE_POSITION_BOTTOMALIGNED' | 'BANNER_X_BACKGROUND_IMAGE_POSITION_FILL'
      - `secondaryBackgroundImageId` string — The unique identifier for the secondary background image.
      - `secondaryBackgroundImagePosition` 'BANNER_X_BACKGROUND_IMAGE_POSITION_UNSPECIFIED' | 'BANNER_X_BACKGROUND_IMAGE_POSITION_REPEATING' | 'BANNER_X_BACKGROUND_IMAGE_POSITION_LEFTALIGNED' | 'BANNER_X_BACKGROUND_IMAGE_POSITION_RIGHTALIGNED' | 'BANNER_X_BACKGROUND_IMAGE_POSITION_TOPALIGNED' | 'BANNER_X_BACKGROUND_IMAGE_POSITION_BOTTOMALIGNED' | 'BANNER_X_BACKGROUND_IMAGE_POSITION_FILL'
      - `heroImageId` string — The unique identifier for the hero image.
      - `heroImageAltText` string — The alternate text for the hero image.
      - `heroMode` 'BANNER_X_HERO_IMAGE_MODE_UNSPECIFIED' | 'BANNER_X_HERO_IMAGE_MODE_BLOCK' | 'BANNER_X_HERO_IMAGE_MODE_LANDSCAPE' | 'BANNER_X_HERO_IMAGE_MODE_PORTRAIT'
      - `secondaryHeroImageId` string — The unique identifier for the secondary hero image.
      - `secondaryHeroImageAltText` string — The alt text for the secondary hero image.
      - `secondaryHeroMode` 'BANNER_X_HERO_IMAGE_MODE_UNSPECIFIED' | 'BANNER_X_HERO_IMAGE_MODE_BLOCK' | 'BANNER_X_HERO_IMAGE_MODE_LANDSCAPE' | 'BANNER_X_HERO_IMAGE_MODE_PORTRAIT'
      - `additionalFields` V3AdditionalFields[] — BannerX AdditionalFields
        - `id` string — The unique identifier for the item.
        - `value` string — The value associated with the item.
      - `trackingTagProvider` V3TrackingTag[] — BannerX TrackingTagProvider
        - `provider` 'TRACKING_TAG_PROVIDER_UNSPECIFIED' | 'TRACKING_TAG_PROVIDER_DV' | 'TRACKING_TAG_PROVIDER_DCM_CLICK' | 'TRACKING_TAG_PROVIDER_DCM_IMPRESSION' | 'TRACKING_TAG_PROVIDER_MOAT' | 'TRACKING_TAG_PROVIDER_IAS' | 'TRACKING_TAG_PROVIDER_GTM360' | 'TRACKING_TAG_PROVIDER_SIZMEK' | 'TRACKING_TAG_PROVIDER_ADFORM_CLICK' | 'TRACKING_TAG_PROVIDER_ADFORM_IMPRESSION' | 'TRACKING_TAG_PROVIDER_DV_IMAGE'
        - `content` string — The content of the tracking tag.
      - `primaryVideoConfig` BannerXConfigVideoConfig
        - `fileId` string — The unique identifier for the video file. Id is generated and provided by Epsilon upload file endpoint
      - `companionProducts` Campaignv3CatalogProductSeller[] — Products to be rendered in BannerX
        - `catalogId` string — The unique identifier of the retailer's catalog.
        - `productCode` string — The product code within the catalog.
        - `sellerId` string — The seller ID for the product. Defaults to an empty string.
    - `bannerConfig` V3BannerConfig
      - `contentStandardId` string — The unique identifier of the content standard.
      - `slotsConfiguration` V3SlotsConfiguration[] — The unique identifier of the slots configuration.
        - `slotId` string — The unique identifier for the slot in the configuration. Example: 'homepage_banner_slot_1'
        - `artworkImageId` string — The identifier for the image used as artwork in the slot. Example: 'image_1234'
        - `link` string — The URL link associated with the slot, directing the user to a target page when clicked. Example: 'https://www.example.com/promo'
        - `altText` string — Alternative text for the artwork image, providing a description for accessibility. Example: 'Promotional banner for summer sale'
        - `text` string — The display text for the slot, providing additional information or a message. Example: 'Get 20% off your first purchase!'
        - `trackingTagProvider` V3TrackingTag[] — List of tracking tags from the provider, required for tracking interactions with the slot. Example: '[ { provider: 'Google Analytics', tag: 'promo_click' }, { provider: 'Adobe Analytics', tag: 'banner_view' } ]'
          - `provider` 'TRACKING_TAG_PROVIDER_UNSPECIFIED' | 'TRACKING_TAG_PROVIDER_DV' | 'TRACKING_TAG_PROVIDER_DCM_CLICK' | 'TRACKING_TAG_PROVIDER_DCM_IMPRESSION' | 'TRACKING_TAG_PROVIDER_MOAT' | 'TRACKING_TAG_PROVIDER_IAS' | 'TRACKING_TAG_PROVIDER_GTM360' | 'TRACKING_TAG_PROVIDER_SIZMEK' | 'TRACKING_TAG_PROVIDER_ADFORM_CLICK' | 'TRACKING_TAG_PROVIDER_ADFORM_IMPRESSION' | 'TRACKING_TAG_PROVIDER_DV_IMAGE'
          - `content` string — The content of the tracking tag.
  - `nextPageToken` string — The page token used to request the next page in pagination. Include it as pageToken in the request.
  - `totalCount` string, int64 — Displays the total number of campaigns that meet the specified criteria.

## Other responses

- `400` — There was a problem with input.
- `401` — Login failed or token not valid.
- `403` — Access denied due to insufficient permissions.
- `default` — An unexpected error response.

---

[API](https://skmtc.net/citrusad/apis/citrus-auth-api.md) · [All operations](https://skmtc.net/citrusad/apis/citrus-auth-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/citrusad/citrus-auth-api/revisions/a040003c7378/schema)