How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Pinterest Promotion API

The Promotion API from Pinterest — 1 operation(s) for promotion.

Pinterest Promotion API is one of 117 APIs that Pinterest publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Promotion. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.

This API exposes 1 operation across 1 path, and defines 9 schemas. It is described by OpenAPI 3.2.0, at version 5.13.0.

Requests are made against a single base URL, https://api.pinterest.com/v5.

1 operations 1 paths 9 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
5.13.0
Base URL
https://api.pinterest.com/v5
Authentication
OAuth 2.0, HTTP Bearer, HTTP Basic
License
Terms of Service
Resource Areas
1

Authentication & Security 3

Pinterest Promotion API declares 3 security schemes for authenticating requests. It supports OAuth 2.0 (pinterest_oauth2) using the authorizationCode flow, exposing 18 scopes. It accepts HTTP bearer tokens (conversion_token). It accepts HTTP basic authentication (basic).

  • conversion_token — This security scheme only applies to the conversion events endpoint (POST /adaccounts/{adaccountid}/events). This endpoint requires a bearer token generated vi…

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Promotion 1
GET
/ad_accounts/{ad_account_id}/product_group_promotions/{product_group_promotion_id}
Get a product group promotion by id
product_group_promotions/get 2 params → 200default

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are ProductGroupPromotion (17 properties), ProductGroupPromotionResponseItem (2 properties), Error (2 properties), Exception (2 properties). Each schema is shown below with its type and property counts.

ProductGroupPromotionResponseElement
object
ProductGroupPromotion
object
17 properties
GridClickType
stringnull
Where a user is taken after clicking on an ad in grid. Note: This parameter is read-only and is set to DIRECTTODESTINATION by default for direct links supporte…
ProductGroupPromotionResponseItem
object
2 properties
EntityStatus
string
Entity status
ProductGroupPromotionResponse
object
1 property
Error
object
2 properties 2 required
CreativeType
string
Ad creative type enum. For update, only draft ads may update creative type. Note: SHOPTHEPIN has been deprecated. Please use COLLECTION instead.
Exception
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

pinterest-promotion-api-openapi.yml Raw ↑

Other APIs Pinterest publishes across the network.

Pinterest Access API
Pinterest Accounts API
Pinterest Ad API
Pinterest Ad_groups API
Pinterest Ads API
Pinterest Analytics API
Pinterest Assets API
Pinterest Audience API
Pinterest Audience_insights API
Pinterest Audiences API
Pinterest Batch API
Pinterest Bid API
Where this information came from

This is an independent, third-party profile of Pinterest Promotion API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.