v29

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

List ads

List ads that meet the filters provided: - Listed campaign ids or ad group ids or ad ids - Listed entity statuses

If no filter is provided, all ads in the ad account are returned.

Note: Provide only campaign_id or ad_group_id or ad_id. Do not provide more than one type.

Review status is provided for each ad; if review_status is REJECTED, the rejected_reasons field will contain additional information.

For more, see Pinterest advertising standards.

get/ad_accounts/{ad_account_id}/ads

Path parameters

ad_account_idstring required

Unique identifier of an ad account.

Query parameters

bookmarkstring

Cursor used to fetch the next page of items

page_sizeinteger

Maximum number of items to include in a single page. See documentation on Pagination for more information.

order'ASCENDING' | 'DESCENDING'

The order in which to sort the items returned: "ASCENDING" or "DESCENDING" by ID. Note that higher-value IDs are associated with more-recently added items.

campaign_idsCampaignIdType[]

List of Campaign Ids to use to filter the results.

ad_group_idsPinterestLibIntegerFormatType[]

List of Ad group Ids to retrieve keywords from. This feature is currently in BETA and is not available to all users.

ad_idsPinterestLibIntegerFormatType[]

List of Ad Ids to use to filter the results.

entity_statusesEntityStatus[]

Entity status

[
  "ACTIVE"
]

Response

The request has succeeded.

bookmarkstring nullable

Example response

{
  "items": [
    {
      "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"
        ]
      }
    }
  ]
}