Sign in

v29

latestOpenAPI 3.0.3MITraw.githubusercontent.com2026-06-042661,1122.5 MB
ads

Get ad

Get a specific ad given the ad ID. If your pin is rejected, rejected_reasons will contain additional information from the Ad Review process. For more information about our policies and rejection reasons see the Pinterest advertising standards.

get/ad_accounts/{ad_account_id}/ads/{ad_id}

Path parameters

ad_idstring required

The ID of this ad.

ad_account_idstring required

Unique identifier of an ad account.

Response

The request has succeeded.

ad_account_idstring required

The ID of the advertiser that this ad belongs to.

ad_group_idstring required

ID of the ad group that contains the ad.

android_deep_linkstring nullable

Deep link URL for Android devices.

campaign_idstring required

ID of the ad campaign that contains this ad.

carousel_android_deep_linksstring[] nullable

Comma-separated deep links for the carousel pin on Android.

carousel_destination_urlsstring[] nullable

Comma-separated destination URLs for the carousel pin to promote.

carousel_ios_deep_linksstring[] nullable

Comma-separated deep links for the carousel pin on iOS.

carting_platform_typeinteger

The vendor platform type of the carting ad. 1 for MIKMAK, 2 for PEAR.

click_tracking_urlstring nullable

Tracking url for the ad clicks.

collection_items_destination_url_templatestring nullable

Destination URL template for all items within a collections drawer.

collections_header_type'SHOP_THIS_COLLECTION' | 'EXPLORE_THIS_COLLECTION' | 'NO_HEADER' | 'null' nullable

Collections ad header type for ads

created_timeinteger

Pin creation time. Unix timestamp in seconds.

creative_type'REGULAR' | 'VIDEO' | 'SHOPPING' | 'CAROUSEL' | 'MAX_VIDEO' | 'SHOP_THE_PIN' | 'COLLECTION' | 'IDEA' | 'SHOWCASE' | 'QUIZ' | 'COLLAGE' | 'MAX_WIDTH_REGULAR_COLLECTION' | 'MAX_WIDTH_VIDEO_COLLECTION' | 'APP' required

Ad creative type enum. Note: SHOP_THE_PIN has been deprecated. Please use COLLECTION instead.

customizable_cta_type'GET_OFFER' | 'LEARN_MORE' | 'ORDER_NOW' | 'SHOP_NOW' | 'SIGN_UP' | 'SUBSCRIBE' | 'BUY_NOW' | 'CONTACT_US' | 'GET_QUOTE' | 'VISIT_SITE' | 'APPLY_NOW' | 'BOOK_NOW' | 'REQUEST_DEMO' | 'REGISTER_NOW' | 'FIND_A_DEALER' | 'ADD_TO_CART' | 'WATCH_NOW' | 'READ_MORE' | 'BUY_TICKETS' | 'DONATE_NOW' | 'DOWNLOAD' | 'EXPLORE_MORE' | 'FIND_A_LOCATION' | 'FIND_RETAILERS' | 'GET_DEAL' | 'GET_RECIPE' | 'GET_SHOWTIMES' | 'ON_SALE' | 'PLAY_GAME' | 'TRY_IT' | 'TAKE_A_PEEK' | 'null' nullable

Select a call to action (CTA) to display below your ad. Available only for ads with direct links enabled. CTA options for consideration and conversion campaigns are LEARN_MORE, SHOP_NOW, BOOK_NOW, SIGN_UP, VISIT_SITE, BUY_NOW, GET_OFFER, ORDER_NOW, ADD_TO_CART (for conversion campaigns with add to cart conversion events only)

destination_urlstring nullable

Destination URL.

disclosure_type'NO_DISCLOSURE' | 'PRESCRIBING_INFORMATION' | 'PRESCRIBING_INFORMATION_BOX_WARNING' | 'IMPORTANT_SAFETY_INFO' | 'MED_GUIDE' | 'PATIENT_INFORMATION' | 'null' nullable

Type of information in the page referenced by disclosure_url, provided either by the Food and Drug Administration (FDA) or the manufacturer.

disclosure_urlstring nullable

URL for a page that provides disclosures about a pharmaceutical product, such as potential side effects. Make sure the URL takes the user directly to the disclosure content and the referenced site is secure.

grid_click_type'CLOSEUP' | 'DIRECT_TO_DESTINATION' nullable

Where a user is taken after clicking on an ad in grid.

Note: This parameter is read-only and is set to DIRECT_TO_DESTINATION by default for direct links supported ads. grid_click_type values provided will be ignored.

idstring required

The ID of this ad.

ios_deep_linkstring nullable

Deep link URL for iOS devices.

is_cartingboolean

Is the ad a carting/WTB ad?

is_collage_accepted_termsboolean

Whether the advertiser has accepted the terms and conditions for collage ad.

is_collage_single_destinationboolean

Whether the collage ad has a single destination url override.

is_pin_deletedboolean

Is original pin deleted?

is_removableboolean

Is pin repinnable?

lead_form_idstring nullable

Lead form ID for lead ad generation.

namestring nullable

Name of the ad - 255 chars max.

pin_idstring required

Pin ID. This field may only be updated for draft ads.

rejected_reasonsAdDisapprovalReasons[] required

Enum reason why the pin was rejected. Returned if review_status is "REJECTED".

rejection_labelsstring[] required

Text reason why the pin was rejected. Returned if review_status is "REJECTED".

review_status'OTHER' | 'PENDING' | 'REJECTED' | 'APPROVED' required

Ad review status

status'ACTIVE' | 'PAUSED' | 'ARCHIVED' | 'DRAFT' | 'DELETED_DRAFT'

Entity status

summary_status'APPROVED' | 'PAUSED' | 'PENDING' | 'REJECTED' | 'ADVERTISER_DISABLED' | 'ARCHIVED' | 'DRAFT' | 'DELETED_DRAFT' required

Summary status for pin promotions

typestring required

Always "ad".

updated_timeinteger

Last update time. Unix timestamp in seconds.

view_tracking_urlstring nullable

Tracking URL for ad impressions.

Example response

{
  "collections_header_type": "SHOP_THIS_COLLECTION",
  "customizable_cta_type": "LEARN_MORE",
  "disclosure_type": "MED_GUIDE",
  "grid_click_type": "CLOSEUP",
  "quiz_pin_data": {
    "questions": [
      {
        "question_id": 1,
        "question_text": "Where do you thrive?",
        "options": [
          {
            "text": "Hangout vibes"
          },
          {
            "text": "Time to party!"
          },
          {
            "text": "Keeping it lowkey"
          }
        ]
      },
      {
        "question_id": 2,
        "question_text": "Where would you nap?",
        "options": [
          {
            "text": "Hammock in the mountains"
          },
          {
            "text": "Beach towel in the sand"
          },
          {
            "text": "Tent under the stars"
          }
        ]
      },
      {
        "question_id": 2,
        "question_text": "Who are you taking?",
        "options": [
          {
            "text": "No one—solo trip!"
          },
          {
            "text": "My best friend"
          },
          {
            "text": "The family"
          }
        ]
      }
    ],
    "results": [
      {
        "organicPinId": "1234",
        "android_deep_link": "https://www.pinterest.com/",
        "iOS_deep_link": "https://www.pinterest.com/",
        "destination_url": "https://www.pinterest.com/",
        "result_id": 1
      },
      {
        "organicPinId": "1234",
        "android_deep_link": "https://www.pinterest.com/",
        "iOS_deep_link": "https://www.pinterest.com/",
        "destination_url": "https://www.pinterest.com/",
        "result_id": 2
      },
      {
        "organicPinId": "1234",
        "android_deep_link": "https://www.pinterest.com/",
        "iOS_deep_link": "https://www.pinterest.com/",
        "destination_url": "https://www.pinterest.com/",
        "result_id": 3
      }
    ]
  },
  "status": "ACTIVE",
  "summary_status": "APPROVED",
  "tracking_urls": {
    "impression": [
      "URL1",
      "URL2"
    ],
    "click": [
      "URL1",
      "URL2"
    ],
    "engagement": [
      "URL1",
      "URL2"
    ],
    "buyable_button": [
      "URL1",
      "URL2"
    ],
    "audience_verification": [
      "URL1",
      "URL2"
    ]
  }
}