ad_accounts14

ad_groups13

ads10

advanced_auction2

audience_insights2

audience_sharing7

audiences4

billing11

boards11

bulk3

business_access_assets12

business_access_invite6

business_access_relationships9

campaigns8

catalog_feeds8

catalog_items3

catalog_product_groups10

catalog_reports3

catalog_supplemental7

catalogs3

conversion_deletion_requests4

conversion_eqs1

conversion_events1

conversion_tags5

conversions4

customer_list_uploads3

customer_lists4

customer_segment3

integrations7

keywords5

labels5

lead_ads4

lead_forms5

leads_export2

media3

msot_events1

notification1

oauth3

order_lines2

pins8

product_group_promotions5

product_tags3

promotions5

resources6

schedules3

search3

targeting_template3

terms2

terms_of_service1

trends4

user_account14

bulk

Download advertiser entities in bulk

Changed on Jun 4, 2026

Get the status of a bulk request by request_id, along with a download URL that will allow you to download the new or updated entity data (campaigns, ad groups, product groups, ads, schedules, or keywords).

get/ad_accounts/{ad_account_id}/bulk/{bulk_request_id}

Request

Base URL
https://api.pinterest.com/v5
Auth
- OAuth 2
  Authorization codehttps://www.pinterest.com/oauth/
  Token URLhttps://api.pinterest.com/v5/oauth/token
  Scopesads:read
- or OAuth 2
  Client credentials
  Token URLhttps://api.pinterest.com/v3/oauth/access_token/
  Scopesads:read
TypeScript
https://skmtc.dev/pinterest/apis/pinterest-rest-api/docs/ad_accounts/:ad_account_id/bulk/:bulk_request_id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

ad_account_idstring required

Unique identifier of an ad account.

bulk_request_idstring required

Bulk request ID that is from one of the entities bulk endpoints

Query parameters

include_detailsboolean

If set to True then attach the errors/details to all the requests

Response

The request has succeeded.

result_urlstring

Presigned s3 file url for the bulk request result.

status'RUNNING' | 'SUCCEEDED' | 'FAILED' required

Bulk request status

workload_idinteger

Bulk Workload Id.

Changes

Jun 4, 2026v5b698c180678a Revision changes
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the optional property to the response with the status
- info
  the response property became required for the status
Apr 4, 2025v510f9eba4ad97 Revision changes
- info
  the endpoint scheme security client_credentials was added to the API

Operation history (4 revisions)