Sign in
pins

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".
get/pins

Query parameters

bookmarkstring

Cursor used to fetch the next page of items

page_sizeinteger

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'exclude_native' | 'exclude_repins' | 'has_been_promoted'

Pin filter.

include_protected_pinsboolean

Specify if return pins from protected boards

pin_type'PRIVATE'

The type of pins to return, currently only enabled for private pins

creative_typesstring[]

Pin creative types filter. </p><strong>Note:</strong> SHOP_THE_PIN has been deprecated. Please use COLLECTION instead.

[
  "REGULAR"
]
ad_account_idstring

Unique identifier of an ad account.

Response

Success

bookmarkstring nullable

Example response

{
  "items": [
    {
      "id": "813744226420795884",
      "created_at": "2020-01-01T20:10:40-00:00",
      "link": "https://www.pinterest.com/",
      "dominant_color": "#6E7874",
      "creative_type": "REGULAR"
    }
  ]
}

Changes