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

lead_ads

Get lead ads subscription by ID

Changed on Jul 16, 2025

Get an existing lead ads webhook subscription by ID.

Only requests for the OWNER or ADMIN of the ad_account will be allowed.'

get/ad_accounts/{ad_account_id}/leads/subscriptions/{subscription_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/leads/subscriptions/:subscription_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.

subscription_idstring required

Unique identifier of a subscription.

Response

The request has succeeded.

ad_account_idstring

The Ad Account ID that this lead form belongs to.

api_versionstring

API version.

created_timeinteger

Subscription creation time. Unix timestamp in milliseconds.

cryptographic_algorithmstring nullable

Lead data encryption algorithm.

cryptographic_keystring nullable

Base64 encoded key for client to decrypt lead data.

idstring

Subscription ID.

lead_form_idstring nullable

Lead form ID.

user_account_idstring

User account used to subscribe lead data.

webhook_urlstring

Standard HTTPS webhook URL.

Changes

Jul 16, 2025v543134ca41f18 Revision changes
- info
  removed subschema #1 subschema #2 from the response body allOf list for the response 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
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
Apr 4, 2025v510f9eba4ad97 Revision changes
- info
  the endpoint scheme security client_credentials was added to the API

Operation history (4 revisions)

Get lead ads subscription by ID

Request

Path parameters

Response 200OK

Changes

Response