List Pins
Get a list of the Pins owned by the "operation user_account".
- By default, the "operation user_account" is the token user_account.
- All Pins owned by the "operation user_account" are included, regardless of who owns the board they are on.
Optional: Business Access: Specify an `ad_account_id` to use the owner of that ad_account as the "operation user_account".
Disclaimer: There are known performance issues when filtering by field `creative_type` and including protected pins.
If your request is timing out in this scenario, we encourage you to use [GET List Pins on Board](/docs/api/v5/#operation/boards/list_pins).
Query parameters
The filter to apply to the pins
Specify whether to return 90d and lifetime Pin metrics. Total comments and total reactions are only available with lifetime Pin metrics. If Pin was created before 2023-03-20 lifetime metrics will only be available for Video and Idea Pin formats. Lifetime metrics are available for all Pin formats since then.
Whether to include protected pins in the results
The type of pins to return, currently only enabled for private pins
Pin creative types filter. Note: SHOP_THE_PIN has been deprecated. Please use COLLECTION instead.
Unique identifier of an ad account.
Only return pins with links that match the exact domain. Domain should not include 'www.' prefix. For example, 'pinterest.com' is a valid domain, but 'www.pinterest.com' is not (will not match any pins).
Only return pins with links whose domain matches any value in the list. Values are joined comma-separated on the wire (e.g. ?domains=instagram.com,jcpenney.com).
Include product tag objects in the response with their associated links.
Cursor used to fetch the next page of items
Maximum number of items to include in a single page. See documentation on Pagination for more information.
Response
The request has succeeded.
Example response
{
"items": [
{
"media": {
"images": {
"150x150": {
"width": 150,
"height": 150,
"url": "https://i.pinimg.com/150x150/0d/f6/f1/0df6f1f0bfe7aaca849c1bbc3607a34b.jpg"
},
"400x300": {
"width": 400,
"height": 300,
"url": "https://i.pinimg.com/400x300/0d/f6/f1/0df6f1f0bfe7aaca849c1bbc3607a34b.jpg"
},
"600x": {
"width": 600,
"height": 600,
"url": "https://i.pinimg.com/600x/0d/f6/f1/0df6f1f0bfe7aaca849c1bbc3607a34b.jpg"
},
"1200x": {
"width": 1200,
"height": 1200,
"url": "https://i.pinimg.com/1200x/0d/f6/f1/0df6f1f0bfe7aaca849c1bbc3607a34b.jpg"
}
}
},
"pin_metrics": {
"90d": {
"pin_click": 7,
"impression": 2,
"clickthrough": 3
},
"lifetime_metrics": {
"pin_click": 7,
"impression": 2,
"clickthrough": 3,
"reaction": 10,
"comment": 2
}
}
}
]
}