List Pins
GET {{baseUrl}}/pins?bookmark=<string>&page_size=25&pin_filter=exclude_repins&include_protected_pins=false&pin_type=PRIVATE&creative_types=SHOP_THE_PIN&creative_types=VIDEO&ad_account_id=15266090296&pin_metrics=false
Get a list of the Pins owned by the operation user_account
.
- By default, the operation user_account
is the token useraccount.
- All Pins owned by the "operation useraccountare 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".
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
bookmark | string | Cursor used to fetch the next page of items | |
page_size | number | Maximum number of items to include in a single page of the response. See documentation on <a href='/docs/getting-started/pagination/'>Pagination</a> for more information. | |
pin_filter | string | Pin filter. | |
include_protected_pins | boolean | Specify if return pins from protected boards | |
pin_type | string | The type of pins to return, currently only enabled for private pins | |
creative_types | string | Pin creative types filter. </p><strong>Note:</strong> SHOP_THE_PIN has been deprecated. Please use COLLECTION instead. | |
creative_types | string | Pin creative types filter. </p><strong>Note:</strong> SHOP_THE_PIN has been deprecated. Please use COLLECTION instead. | |
ad_account_id | number | Unique identifier of an ad account. | |
pin_metrics | boolean | 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 <code>2023-03-20</code> lifetime metrics will only be available for Video and Idea Pin formats. Lifetime metrics are available for all Pin formats since then. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"items":[{"id":"70734","created_at":"\u003cdateTime\u003e","link":"\u003cstring\u003e","title":"\u003cstring\u003e","description":"\u003cstring\u003e","dominant_color":"\u003cstring\u003e","alt_text":"\u003cstring\u003e","creative_type":"CAROUSEL","board_id":"618","board_section_id":"079822","board_owner":{"username":"\u003cstring\u003e"},"is_owner":"\u003cboolean\u003e","media":{"media_type":"\u003cstring\u003e"},"media_source":{"source_type":"image_base64","content_type":"image/png","data":"48NLPhC5bn","is_standard":true},"parent_pin_id":"104","is_standard":"\u003cboolean\u003e","has_been_promoted":"\u003cboolean\u003e","note":"\u003cstring\u003e","pin_metrics":{}},{"id":"57722","created_at":"\u003cdateTime\u003e","link":"\u003cstring\u003e","title":"\u003cstring\u003e","description":"\u003cstring\u003e","dominant_color":"\u003cstring\u003e","alt_text":"\u003cstring\u003e","creative_type":"QUIZ","board_id":"190000","board_section_id":"5371750","board_owner":{"username":"\u003cstring\u003e"},"is_owner":"\u003cboolean\u003e","media":{"media_type":"\u003cstring\u003e"},"media_source":{"source_type":"image_base64","content_type":"image/png","data":"efC","is_standard":true},"parent_pin_id":"61104","is_standard":"\u003cboolean\u003e","has_been_promoted":"\u003cboolean\u003e","note":"\u003cstring\u003e","pin_metrics":{}}],"bookmark":"\u003cstring\u003e"}