---
title: "Get advertiser defined events"
method: GET
path: "/ad_accounts/{ad_account_id}/advertiser_defined_events"
tags: ["conversions"]
---

# Get advertiser defined events

`GET /ad_accounts/{ad_account_id}/advertiser_defined_events`

## Request

- Base URL: `https://api.pinterest.com/v5`
- URL: `https://api.pinterest.com/v5/ad_accounts/{ad_account_id}/advertiser_defined_events`
- Auth: one of:
  - OAuth 2
    - Authorization code: `https://www.pinterest.com/oauth/`
    - Token URL: `https://api.pinterest.com/v5/oauth/token` scopes: `ads:read`
  - OAuth 2
    - Client credentials
    - Token URL: `https://api.pinterest.com/v3/oauth/access_token/` scopes: `ads: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)

Get advertiser defined events for the given ad account.

## Path parameters

- `ad_account_id` string, required

## Response `200`

The request has succeeded.

- object
  - `items` AdvertiserDefinedEvent[], required
    - `mapped_conversion_type` 'PAGE_LOAD' | 'UNKNOWN' | 'INITIALIZED' | 'PAGE_VISIT' | 'SIGNUP' | 'CHECKOUT' | 'CUSTOM' | 'VIEW_CATEGORY' | 'SEARCH' | 'ADD_TO_CART' | 'WATCH_VIDEO' | 'LEAD' | 'APP_INSTALL' | 'WEB_SESSION' | 'EXTERNAL_MEASUREMENT' | 'ADD_PAYMENT_INFO' | 'ADD_TO_WISHLIST' | 'INITIATE_CHECKOUT' | 'SUBSCRIBE' | 'VIEW_CONTENT' | 'ADVERTISER_DEFINED_EVENT' | 'APP_OPEN' | 'CONTACT' | 'SCHEDULE' | 'FIND_LOCATION' | 'CUSTOMIZE_PRODUCT' | 'SUBMIT_APPLICATION' | 'START_TRIAL': Conversion tag type
    - `name` string: Raw string name of the event, usually logged as raw_event_name in our dataset

## Other responses

- `400`: The request could not be understood by the server due to unexpected data.
- `401`: Authentication is required and has either failed or not been provided.
- `403`: The request was valid, but the server is refusing action. The user might not have the necessary permissions for a resource.
- `404`: The requested resource could not be found on this server.
- `429`: The user has sent too many requests in a given amount of time and is being rate limited.
- `default`: An unexpected error response.

## Changes

- **2026-06-04** (v5) `b698c180678a`: 8 info
  - added the non-success response with the status `400`
  - added the non-success response with the status `401`
  - added the non-success response with the status `403`
  - added the non-success response with the status `404`
  - …4 more
- **2025-12-11** (v5) `79f62f71f05b`: 7 warning
  - added the new `APP_OPEN` enum value to the `items/items/mapped_conversion_type/anyOf[subschema #1]/` response property for the response status `200`
  - added the new `CONTACT` enum value to the `items/items/mapped_conversion_type/anyOf[subschema #1]/` response property for the response status `200`
  - added the new `CUSTOMIZE_PRODUCT` enum value to the `items/items/mapped_conversion_type/anyOf[subschema #1]/` response property for the response status `200`
  - added the new `FIND_LOCATION` enum value to the `items/items/mapped_conversion_type/anyOf[subschema #1]/` response property for the response status `200`
  - …3 more
- **2025-10-16** (v5) `14c297539b64`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/pinterest/apis/pinterest-rest-api/changes/ad_accounts/:ad_account_id/advertiser_defined_events/get.md)

---

[API](https://skmtc.dev/pinterest/apis/pinterest-rest-api.md) - [All operations](https://skmtc.dev/pinterest/apis/pinterest-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/pinterest/apis/pinterest-rest-api/revisions/b698c180678a?raw)
