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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Pinterest

Pinterest Groups API

The Groups API from Pinterest — 15 operation(s) for groups.

Documentation Provider Profile APIs.io OpenAPI GitHub

Pinterest Groups 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 Group. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.

This API exposes 23 operations across 15 paths, and defines 126 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.

23 operations 15 paths 126 schemas 2 DELETE12 GET3 PATCH6 POST

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
Contact
Pinterest, Inc.
License
MIT
Terms of Service
View terms
Resource Areas
1

Authentication & Security 3

Pinterest Groups 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 23

Across 15 paths, the API surfaces 23 operations — 2 DELETE, 12 GET, 3 PATCH, 6 POST. Each is listed below with its method, path, parameters, and response codes.

Groups 23
GET
/ad_accounts/{ad_account_id}/ad_groups
List ad groups
ad_groups/list 8 params → 200400default
POST
/ad_accounts/{ad_account_id}/ad_groups
Create ad groups
ad_groups/create 1 param body → 200default
PATCH
/ad_accounts/{ad_account_id}/ad_groups
Update ad groups
ad_groups/update 1 param body → 200default
GET
/ad_accounts/{ad_account_id}/ad_groups/analytics
Get ad group analytics
ad_groups/analytics 10 params → 200400default
GET
/ad_accounts/{ad_account_id}/ad_groups/targeting_analytics
Get targeting analytics for ad groups
ad_groups_targeting_analytics/get 12 params → 200default
POST
/ad_accounts/{ad_account_id}/ad_groups/audience_sizing
Get audience sizing
ad_groups/audience_sizing 1 param body → 200400403default
GET
/ad_accounts/{ad_account_id}/ad_groups/{ad_group_id}
Get ad group
ad_groups/get 2 params → 200default
POST
/ad_accounts/{ad_account_id}/product_group_promotions
Create product group promotions
product_group_promotions/create 1 param body → 200default
PATCH
/ad_accounts/{ad_account_id}/product_group_promotions
Update product group promotions
product_group_promotions/update 1 param body → 200default
GET
/ad_accounts/{ad_account_id}/product_group_promotions
Get product group promotions
product_group_promotions/list 7 params → 200default
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
GET
/ad_accounts/{ad_account_id}/product_groups/analytics
Get product group analytics
product_groups/analytics 10 params → 200400default
GET
/ad_accounts/{ad_account_id}/product_groups/catalogsdeprecated
Get catalog product groups
ad_accounts_catalogs_product_groups/list 2 params → 200400401404default
DELETE
/catalogs/product_groups/multiple
Delete multiple product groups
catalogs_product_groups/delete_many 2 params → 204401403404409default
POST
/catalogs/product_groups/multiple
Create multiple product group
catalogs_product_groups/create_many 1 param body → 201400401403409default
GET
/catalogs/product_groups
List product groups
catalogs_product_groups/list 6 params → 200400401403404409default
POST
/catalogs/product_groups
Create single product group
catalogs_product_groups/create 1 param body → 201400401403409default
GET
/catalogs/product_groups/{product_group_id}
Get single product group
catalogs_product_groups/get 2 params → 200400401403404409default
DELETE
/catalogs/product_groups/{product_group_id}
Delete single product group
catalogs_product_groups/delete 2 params → 204400401403404409default
PATCH
/catalogs/product_groups/{product_group_id}
Update single product group
catalogs_product_groups/update 2 params body → 200400401403404409default
GET
/catalogs/product_groups/{product_group_id}/product_counts
Get product counts for a Product Group
catalogs_product_groups/product_counts_get 2 params → 200404409default
GET
/catalogs/product_groups/{product_group_id}/products
List products for a Product Group
catalogs_product_group_pins/list 4 params → 200400401404default
POST
/catalogs/products/get_by_product_group_filters
List products for Product Group Filters
products_by_product_group_filter/list 3 params body → 200401409default

Schemas 126

The contract defines 126 schemas that model the data the API accepts and returns. The most detailed are Pin (19 properties), AdGroupCommon (18 properties), ProductGroupPromotion (17 properties), CatalogsRetailProductGroup (12 properties). Each schema is shown below with its type and property counts.

ProductGroupPromotionResponseElement
object
MatchTypeResponse
stringnull
Keyword match type
ProductType2Filter
object
1 property 1 required
CatalogsProductGroupStatus
string
PinMedia
object
Pin media objects.
1 property
CatalogsHotelProductGroupFilterKeys
GoogleProductCategory4Filter
object
1 property 1 required
CustomLabel4Filter
object
1 property 1 required
GoogleProductCategory6Filter
object
1 property 1 required
OptimizationGoalMetadata
object
3 properties
Paginated
object
2 properties 1 required
NonNullableProductAvailabilityType
string
Product availability.
CatalogsVerticalProductGroupCreateRequest
object
Request object for creating a catalog based product group.
MediaType
string
MaxPriceFilter
object
1 property 1 required
ConditionFilter
object
1 property 1 required
CatalogsProductGroupType
string
Catalog product group type MERCHANTCREATED: Product groups created by merchants. ALLPRODUCTS: Consists of every product in your latest successful feed upload.…
Granularity
string
Granularity
TargetingSpec
object
Ad group targeting specification defining the ad group target audience. For example, {"APPTYPE":["iphone"], "GENDER":["male"], "LOCALE":["en-US"], "LOCATION":[…
11 properties
PinMediaSourceImageBase64
object
Base64-encoded image media source
4 properties 3 required
CatalogsVerticalProductGroupUpdateRequest
object
Request object for updating a catalog based product group.
CatalogsProduct
object
2 properties 2 required
CatalogsRetailProductGroup
object
12 properties 5 required
CatalogsCreativeAssetsProductGroupCreateRequest
object
Request object for creating a creative assets product group.
5 properties 4 required
ProductGroupPromotionResponseItem
object
2 properties
CatalogsCreativeAssetsProductGroupFilters
object
Object holding a group of filters for a creative assets product group
AdGroupSummaryStatus
string
Summary status for ad group
CatalogsCreativeAssetsProductGroupFiltersAnyOf
object
1 property 1 required
Pin
objectnull
Pin
19 properties
CatalogsLocale
string
PacingDeliveryType
string
Ad group pacing delivery type. With ACCELERATED, an ad group budget is spent as fast as possible. With STANDARD, an ad group budget is spent smoothly over a da…
ActionType
string
Ad group billable event type. For update, only draft ad groups may update billable event.
AdGroupCommon
object
18 properties
GoogleProductCategory1Filter
object
1 property 1 required
CatalogsHotelProductGroupCreateRequest
object
Request object for creating a hotel product group.
5 properties 4 required
CatalogsProductGroupFiltersAnyOf
object
1 property 1 required
GoogleProductCategory5Filter
object
1 property 1 required
CatalogsRetailProductGroupCreateRequest
object
Request object for creating a product group.
7 properties 6 required
CatalogsProductGroupFilterKeys
CatalogsHotelProductGroupUpdateRequest
object
Request object for updating a hotel product group.
4 properties
Board
object
Board
11 properties 1 required
ProductGroupPromotionCreateRequest
object
2 properties 2 required
CreativeAssetsIdFilter
object
1 property 1 required
ProductGroupPromotionUpdateRequest
object
2 properties 2 required
AdGroupArrayResponseElement
object
2 properties
CatalogsProductGroupPricingCriteria
object
3 properties 1 required
CatalogsProductGroupFiltersRequest
object
Object holding a group of filters for request on catalog product group. This is a distinct schema It is not possible to create or update a Product Group with e…
GoogleProductCategory2Filter
object
1 property 1 required
HotelIdFilter
object
1 property 1 required
GoogleProductCategory3Filter
object
1 property 1 required
ProductType4Filter
object
1 property 1 required
CatalogsVerticalProductGroup
object
CatalogsRetailProductGroupUpdateRequest
object
Request object for updating a retail product group.
6 properties
CustomLabel1Filter
object
1 property 1 required
Country
string
Country ID from ISO 3166-1 alpha-2.
AdGroupUpdateRequest
object
NonNullableCatalogsCurrency
string
Currency Codes from ISO 4217.
AdGroupAudienceSizingRequest
object
6 properties
CatalogsProductGroupMultipleGenderCriteria
object
2 properties 1 required
CatalogsProductGroupCreateRequest
object
Request object for creating a product group.
5 properties 3 required
BudgetType
string
Budget type. If DAILY, an ad group's daily spend will not exceed the budget parameter value. If LIFETIME, the endtime parameter is REQUIRED, and the ad group s…
PriceFilter
object
1 property 1 required
CurrencyFilter
object
1 property 1 required
CatalogsCreativeAssetsProductGroupFiltersAllOf
object
1 property 1 required
PinMediaSourcePinURL
object
Pin URL-based media source for product pin creation. Currently the field is only available to a list of beta users.
2 properties 1 required
MinPriceFilter
object
1 property 1 required
ProductGroupAnalyticsResponse
array
CatalogsProductGroupUpdateRequest
object
Request object for updating a product group.
4 properties
CustomLabel3Filter
object
1 property 1 required
ConversionReportAttributionType
string
Attribution type. Refers to the Pinterest Tag endpoints
ItemIdFilter
object
1 property 1 required
CatalogsProductGroupProductCounts
object
Product counts for a CatalogsProductGroup
4 properties 4 required
CatalogsCreativeAssetsProductGroup
object
8 properties 4 required
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…
PinMediaSourceImagesURL
object
Multiple images urls-based media source
3 properties 1 required
ProductGroupPromotionCreateRequestElement
object
ProductGroupReferenceFilter
object
1 property 1 required
ProductType0Filter
object
1 property 1 required
EntityStatus
string
Entity status
CatalogsProductMetadata
object
Product metadata entity
6 properties 6 required
MediaTypeFilter
object
1 property 1 required
PinMediaSource
Pin media source.
CustomLabel2Filter
object
1 property 1 required
ItemGroupIdFilter
object
1 property 1 required
BrandFilter
object
1 property 1 required
Error
object
2 properties 2 required
AdGroupResponse
object
CatalogsHotelProductGroupFiltersAnyOf
object
1 property 1 required
PlacementGroupType
string
Campaign placement group type
AdGroupArrayResponse
object
1 property
CatalogsProductGroupMultipleCountriesCriteria
object
2 properties 1 required
CatalogsProductGroupMultipleStringListCriteria
object
2 properties 1 required
PinMediaSourceImagesBase64
object
Multiple Base64-encoded images media source
3 properties 1 required
CatalogsProductGroupCurrencyCriteria
object
A currency filter. This filter cannot be negated
2 properties 1 required
ProductType3Filter
object
1 property 1 required
AdGroupCreateRequest
object
GenderFilter
object
1 property 1 required
CatalogsHotelProductGroupFiltersAllOf
object
1 property 1 required
Exception
object
2 properties
CatalogsHotelProductGroupFilters
object
Object holding a group of filters for a hotel product group
CountryFilter
object
1 property 1 required
MetricsResponse
object
1 property
CatalogsListProductsByFilterRequest
object
Request object to list products for a given product group filter.
GoogleProductCategory0Filter
object
1 property 1 required
PinMediaSourceVideoID
object
Video ID-based media source
6 properties 2 required
ProductGroupPromotion
object
17 properties
AdsAnalyticsTargetingType
string
Reporting targeting type
PinMediaSourceImageURL
object
Image URL-based media source
3 properties 2 required
AdGroupsAnalyticsResponse
array
ProductType1Filter
object
1 property 1 required
CatalogsProductGroupMultipleStringCriteria
object
2 properties 1 required
CatalogsProductGroupMultipleMediaTypesCriteria
object
2 properties 1 required
TrackingUrls
objectnull
Third-party tracking URLs. Up to three tracking URLs - with a max length of 2,000 - are supported for each event type. Tracking URLs set at the ad group or ad…
5 properties
CreativeType
string
Ad creative type enum. For update, only draft ads may update creative type. Note: SHOPTHEPIN has been deprecated. Please use COLLECTION instead.
Gender
string
AdGroupAudienceSizingResponse
object
2 properties
ProductGroupPromotionResponse
object
1 property
CustomLabel0Filter
object
1 property 1 required
AvailabilityFilter
object
1 property 1 required
CatalogsHotelProductGroup
object
8 properties 4 required
CatalogsProductGroupFiltersAllOf
object
1 property 1 required
CatalogsCreativeAssetsProductGroupUpdateRequest
object
Request object for updating a creative assets product group.
4 properties
CatalogsCreativeAssetsProductGroupFilterKeys
BoardOwner
object
1 property
CatalogsProductGroupFilters
object
Object holding a group of filters for a catalog product group
CatalogProductGroup
object
non-promoted catalog product group entity
12 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

pinterest-groups-api-openapi.yml Raw ↑

Other APIs Pinterest publishes across the network.

Pinterest Access API
AE Profile APIs.io
Pinterest Accounts API
AE Profile APIs.io
Pinterest Ad API
AE Profile APIs.io
Pinterest Ad_groups API
AE Profile APIs.io
Pinterest Ads API
AE Profile APIs.io
Pinterest Analytics API
AE Profile APIs.io
Pinterest Assets API
AE Profile APIs.io
Pinterest Audience API
AE Profile APIs.io
Pinterest Audience_insights API
AE Profile APIs.io
Pinterest Audiences API
AE Profile APIs.io
Pinterest Batch API
AE Profile APIs.io
Pinterest Bid API
AE Profile APIs.io
#Group
← Back to P APIs
API Details
ID
pinterest:pinterest-groups-api
Base URL
https://api.pinterest.com/v5
Docs
https://developers.pinterest.com/
Provider
Pinterest
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=pinterest-groups-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/pinterest-groups-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Pinterest Groups 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.