---
title: "GET /v1/promotions"
method: GET
path: "/v1/promotions"
tags: ["Promotion"]
---

# GET /v1/promotions

`GET /v1/promotions`

## Query parameters

- `filter` string
- `q` string
- `skip` integer
- `limit` integer
- `start` string
- `end` string
- `subtenantId` string
- `subtenantIds` string[]
- `groupId` string
- `tagIds` string[]
- `tagIdsGroup2` string[]
- `tagIdsGroup3` string[]
- `topicIds` string[]
- `channels` string[]
- `promotionStatus` 'ALL' | 'DRAFT' | 'PLANNED' | 'IN_PROGRESS' | 'STOPPED' | 'IN_REVIEW' | 'COMPLETED'
- `promotionType` 'ALL' | 'TRAFFIC' | 'CONVERSIONS' | 'RETARGETING' | 'SHOPPING' | 'APP' | 'ENGAGEMENT' | 'VIDEO_VIEWS' | 'CALLS' | 'REACH' | 'FOLLOWERS' | 'PROFILE_VIEWS' | 'LEADS' | 'PERFORMANCE_MAX' | 'SMART'
- `orderKey` string
- `reverseOrder` boolean
- `dateFilterField` 'DEFAULT' | 'CREATED' | 'PUBLISHED'

## Headers

- `adhookToken` string
- `Authorization` string

## Response `default`

default response

- PromotionHeader[]
  - `id` string
  - `title` string
  - `type` 'TRAFFIC' | 'CONVERSIONS' | 'RETARGETING' | 'SHOPPING' | 'CARS' | 'REAL_ESTATE' | 'JOBS' | 'EVENTS' | 'APP' | 'ENGAGEMENT' | 'VIDEO_VIEWS' | 'CALLS' | 'REACH' | 'FOLLOWERS' | 'PROFILE_VIEWS' | 'LEADS' | 'PERFORMANCE_MAX' | 'DEMAND_GEN' | 'SMART'
  - `status` 'CREATED' | 'READY' | 'PLANNED' | 'BLOCKED' | 'IN_PROGRESS' | 'COMPLETED' | 'DELETED' | 'STOPPED' | 'ERROR' | 'ACTIVATING' | 'IMPORTING' | 'READY_FOR_PAYMENT' | 'IN_REVIEW' | 'LOCKED' | 'PRODUCT_SYNCHRONIZING' | 'CHECK_REVIEW_FEEDBACK'
  - `color` string
  - `createdAt` string, date-time
  - `createdByUserEmail` string
  - `subtenantId` string
  - `createdByUserId` string
  - `tenantId` string
  - `totalCost` number, double
  - `start` string, date-time
  - `end` string, date-time
  - `nbrOfDays` integer
  - `durationType` 'SHORT_TERM' | 'LONG_TERM'
  - `version` integer
  - `impressions` integer
  - `clicks` integer
  - `cost` number, double
  - `netCost` number, double
  - `conversions` number, double
  - `conversionValue` number, double
  - `ctr` number, double
  - `cpc` number, double
  - `cpm` number, double
  - `reactions` integer
  - `importOrigin` 'GOOGLE_ADWORDS' | 'FACEBOOK' | 'LINKED_IN' | 'TWITTER' | 'TIKTOK' | 'PINTEREST'
  - `mode` 'SIMPLE' | 'EXTENDED' | 'EXPERT'
  - `tags` Tag[]
    - `id` string
    - `userId` string
    - `tenantId` string
    - `subtenantId` string
    - `text` string
    - `color` string
    - `mode` 'MEDIA_LIBRARY' | 'POST_TEMPLATE' | 'MODERATION'
    - `textFR` string
    - `textEN` string
    - `textIT` string
    - `textES` string
    - `templateCategory` TemplateCategory
      - `id` string
      - `userId` string
      - `tenantId` string
      - `name` string
      - `nameEN` string
      - `nameFR` string
      - `nameES` string
      - `nameIT` string
  - `source` 'TARGETING_TOOL' | 'TEMPLATE' | 'LEAD_CHATBOT' | 'GENERATION'
  - `processReviewFeedback` string
  - `activationErrorMessage` string
  - `activationErrorChannel` 'FACEBOOK' | 'INSTAGRAM' | 'GOOGLE_ADWORDS' | 'GOOGLE_DISPLAY_NETWORK' | 'GOOGLE_ANALYTICS' | 'YOUTUBE' | 'XING' | 'LINKED_IN' | 'TWITTER' | 'GOOGLE_MY_BUSINESS' | 'TIKTOK' | 'BITLY' | 'THREADS' | 'BLUESKY' | 'WHATSAPP' | 'PINTEREST' | 'CANVA' | 'HUBSPOT' | 'SALESFORCE' | 'BREVO' | 'SISTRIX' | 'NEWS' | 'BEEKEEPER' | 'TEADS' | 'MASTODON' | 'SNAPCHAT' | 'PIXXIO'
  - `activationStatus` 'PENDING' | 'ERROR' | 'COMPLETED'
  - `processTaskAssigneeUserId` string
  - `processTaskAssigneeUserIds` string[]
  - `channelConfigurations` ChannelConfiguration[]
    - `channel` 'FACEBOOK' | 'INSTAGRAM' | 'GOOGLE_ADWORDS' | 'GOOGLE_DISPLAY_NETWORK' | 'GOOGLE_ANALYTICS' | 'YOUTUBE' | 'XING' | 'LINKED_IN' | 'TWITTER' | 'GOOGLE_MY_BUSINESS' | 'TIKTOK' | 'BITLY' | 'THREADS' | 'BLUESKY' | 'WHATSAPP' | 'PINTEREST' | 'CANVA' | 'HUBSPOT' | 'SALESFORCE' | 'BREVO' | 'SISTRIX' | 'NEWS' | 'BEEKEEPER' | 'TEADS' | 'MASTODON' | 'SNAPCHAT' | 'PIXXIO'
    - `selected` boolean
    - `googleUser` GoogleUser
      - `emailAddress` string
      - `googleCredentials` string
      - `customerId` string
      - `mccCustomerId` string
      - `analyticsProfileId` string
      - `analyticsType` 'UNIVERSAL' | 'GA4'
      - `name` string
      - `accountType` 'AD_ACCOUNT' | 'USER_ACCOUNT'
      - `currency` string
      - `youTubeChannelId` string
      - `expiresInSeconds` integer
      - `refreshToken` string
    - `facebookUser` FacebookUser
      - `internalId` string
      - `name` string
      - `accessToken` string
      - `accountId` string
      - `email` string
      - `accountType` 'AD_ACCOUNT' | 'USER_ACCOUNT'
      - `currency` string
      - `metaReAuthReminderCount` integer
      - `metaReAuthReminderLastSentAt` string, date-time
    - `linkedInUser` LinkedInUser
      - `name` string
      - `accessToken` string
      - `accountId` string
      - `email` string
      - `expires` string
      - `accountType` 'AD_ACCOUNT' | 'USER_ACCOUNT'
      - `currency` string
      - `refreshToken` string
      - `refreshTokenExpires` string
      - `status` 'ACTIVE' | 'CANCELED' | 'DRAFT' | 'REMOVED'
    - `twitterUser` TwitterUser
      - `name` string
      - `accessToken` string
      - `accessTokenSecret` string
      - `accountId` string
      - `email` string
      - `accountType` 'AD_ACCOUNT' | 'USER_ACCOUNT'
      - `currency` string
    - `tikTokUser` TikTokUser
      - `name` string
      - `accessToken` string
      - `expires` string
      - `refreshToken` string
      - `refreshTokenExpires` string
      - `accessTokenSecret` string
      - `accountId` string
      - `email` string
      - `accountType` 'AD_ACCOUNT' | 'USER_ACCOUNT'
      - `currency` string
      - `displayName` string
      - `profileImageUrl` string
      - `profileImageId` string
    - `pinterestUser` PinterestUser
      - `internalId` string
      - `name` string
      - `accessToken` string
      - `expires` string
      - `accountId` string
      - `refreshToken` string
      - `refreshTokenExpires` string
      - `accountType` 'AD_ACCOUNT' | 'USER_ACCOUNT'
      - `currency` string
      - `instanceUrl` string
      - `accountKey` string
      - `server` string
      - `uniqueIdentifier` string
    - `mastodonUser` MastodonUser
      - `internalId` string
      - `name` string
      - `accessToken` string
      - `expires` string
      - `accountId` string
      - `refreshToken` string
      - `refreshTokenExpires` string
      - `accountType` 'AD_ACCOUNT' | 'USER_ACCOUNT'
      - `currency` string
      - `instanceUrl` string
      - `accountKey` string
      - `server` string
      - `uniqueIdentifier` string
    - `snapchatUser` SnapchatUser
      - `internalId` string
      - `name` string
      - `accessToken` string
      - `expires` string
      - `accountId` string
      - `refreshToken` string
      - `refreshTokenExpires` string
      - `accountType` 'AD_ACCOUNT' | 'USER_ACCOUNT'
      - `currency` string
      - `instanceUrl` string
      - `accountKey` string
      - `server` string
      - `organizationId` string
      - `uniqueIdentifier` string
    - `campaignGroup` CampaignGroup
      - `id` string
      - `name` string
      - `status` 'ACTIVE' | 'ARCHIVED' | 'CANCELED' | 'DRAFT' | 'PAUSED' | 'REMOVED'
    - `activationStatus` 'PENDING' | 'ERROR' | 'COMPLETED'
    - `activationErrorMessage` string

---

[API](https://skmtc.net/adhook/apis/adhook-io-api.md) · [All operations](https://skmtc.net/adhook/apis/adhook-io-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/adhook/adhook-io-api/revisions/77eb5d6ad7c9/schema)