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

conversions

Get advertiser defined events

Changed on Jun 4, 2026

Get advertiser defined events for the given ad account.

get/ad_accounts/{ad_account_id}/advertiser_defined_events

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/advertiser_defined_events/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.

Response

The request has succeeded.

Example response

{
  "items": [
    {
      "mapped_conversion_type": "PAGE_LOAD",
      "name": "newsletter_signup"
    }
  ]
}

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 to the // response property allOf list for the response status
- info
  removed subschema #1 subschema #2 from the // response property anyOf list for the response status
- info
  the response property became required for the status
Dec 11, 2025v579f62f71f05b Revision changes
- warning
  added the new APP_OPEN enum value to the /// response property for the response status
- warning
  added the new CONTACT enum value to the /// response property for the response status
- warning
  added the new CUSTOMIZE_PRODUCT enum value to the /// response property for the response status
- warning
  added the new FIND_LOCATION enum value to the /// response property for the response status
- warning
  added the new SCHEDULE enum value to the /// response property for the response status
- warning
  added the new START_TRIAL enum value to the /// response property for the response status
- warning
  added the new SUBMIT_APPLICATION enum value to the /// response property for the response status

Operation history (3 revisions)