search

Search user's Pins

Search for pins for the "operation user_account".

  • By default, the "operation user_account" is the token user_account.

If using Business Access: Specify an ad_account_id to use the owner of that ad_account as the "operation user_account". See Understanding Business Access for more information.

get/search/pins

Query parameters

ad_account_idstring

Unique identifier of an ad account.

querystring required

Search query. Can contain pin description keywords or comma-separated pin IDs.

bookmarkstring

Cursor used to fetch the next page of items

Response

The request has succeeded.

bookmarkstring nullable

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
        }
      }
    }
  ]
}

Changes

Changed in 11 of the 29 revisions of this API.101142

  • v5b698c180678a17See the full diff
    • the response's body type/format changed from / to object/ for status 200

      response-body-type-changed

    • removed Paginated subschema #2 from the response body allOf list for the response status 200

      response-body-all-of-removed

    • added the non-success response with the status 400

      response-non-success-status-added

    • added the non-success response with the status 401

      response-non-success-status-added

    • added the non-success response with the status 403

      response-non-success-status-added

    • added the non-success response with the status 429

      response-non-success-status-added

    • added the optional property bookmark to the response with the 200 status

      response-optional-property-added

    • added the required property items to the response with the 200 status

      response-required-property-added

    This revision also has 182 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • removed the optional property allOf[subschema #2]/items/items/note from the response with the 200 status

      response-optional-property-removed

    • added the new COLLAGE enum value to the allOf[subschema #2]/items/items/creative_type/allOf[subschema #1: CreativeType enum used ads]/ response property for the response status 200

      response-property-enum-value-added

    • added the new MAX_WIDTH_REGULAR_COLLECTION enum value to the allOf[subschema #2]/items/items/creative_type/allOf[subschema #1: CreativeType enum used ads]/ response property for the response status 200

      response-property-enum-value-added

    • added the new MAX_WIDTH_VIDEO_COLLECTION enum value to the allOf[subschema #2]/items/items/creative_type/allOf[subschema #1: CreativeType enum used ads]/ response property for the response status 200

      response-property-enum-value-added

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v57d64d863909a427See the full diff
    • added PinMediaWithImage PinMediaWithVideo PinMediaWithImages PinMediaWithVideos PinMediaWithImageAndVideo to the allOf[subschema #2]/items/items/media/allOf[subschema #1: Pin media -> subschema #1: Pin media response object.]/ response property oneOf list for the response status 200

      response-property-one-of-added

    • the allOf[subschema #2]/items/items/board_owner response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • the allOf[subschema #2]/items/items/creative_type response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • the allOf[subschema #2]/items/items/media response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • removed the optional property allOf[subschema #2]/items/items/is_removable from the response with the 200 status

      response-optional-property-removed

    • removed the optional property allOf[subschema #2]/items/items/product_tags from the response with the 200 status

      response-optional-property-removed

    • the response optional property allOf[subschema #2]/items/items/id became not read-only for the status 200

      response-optional-property-became-not-read-only

    • the response optional property allOf[subschema #2]/items/items/is_standard became read-only for the status 200

      response-optional-property-became-read-only

    • the response optional property allOf[subschema #2]/items/items/pin_metrics became read-only for the status 200

      response-optional-property-became-read-only

    • removed the optional write-only property allOf[subschema #2]/items/items/media_source from the response with the 200 status

      response-optional-write-only-property-removed

    • removed PinMediaBase subschema #2 from the allOf[subschema #2]/items/items/media/allOf[subschema #1: Pin media -> subschema #1: Pin media response object.]/ response property allOf list for the response status 200

      response-property-all-of-removed

    • the response property allOf[subschema #2]/items/items/id became required for the status 200

      response-property-became-required

    • added discriminator to allOf[subschema #2]/items/items/media/allOf[subschema #1: Pin media -> subschema #1: Pin media response object.]/ response property for the response status 200

      response-property-discriminator-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the optional property allOf[subschema #2]/items/items/is_removable to the response with the 200 status

      response-optional-property-added

    • added the optional property allOf[subschema #2]/items/items/product_tags to the response with the 200 status

      response-optional-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v510f9eba4ad9713See the full diff
    • removed the optional property allOf[subschema #2]/items/items/media/allOf[subschema #1: Pin media]/media_type from the response with the 200 status

      response-optional-property-removed

    • added the optional property allOf[subschema #2]/items/items/media_source/allOf[subschema #1: Pin media source]/oneOf[subschema #3: Video ID]/cover_image_key_frame_time to the response with the 200 status

      response-optional-property-added

    • added PinMediaBase subschema #2 to the allOf[subschema #2]/items/items/media/allOf[subschema #1: Pin media]/ response property allOf list for the response status 200

      response-property-all-of-added

    • removed discriminator from allOf[subschema #2]/items/items/media/allOf[subschema #1: Pin media]/ response property for the response status 200

      response-property-discriminator-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • the allOf[subschema #2]/ response's property type/format changed from / to object/ for status 200

      response-property-type-changed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the optional property allOf[subschema #2]/items/items/pin_metrics to the response with the 200 status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the optional property allOf[subschema #2]/items/items/media_source/allOf[subschema #1: Pin media source]/oneOf[subschema #6: Pin URL]/is_affiliate_link to the response with the 200 status

      response-optional-property-added

  • v552586a274771210See the full diff
    • the response property allOf[subschema #2]/items/items/media_source/allOf[subschema #1: Pin media source]/oneOf[subschema #3: Video ID]/cover_image_url became optional for the status 200

      response-property-became-optional

    • added PinMediaSourcePinURL to the allOf[subschema #2]/items/items/media_source/allOf[subschema #1: Pin media source]/ response property oneOf list for the response status 200

      response-property-one-of-added

    • removed the pattern (?!^\d+$)^.+$ from the query request parameter query

      request-parameter-pattern-removed

    • added the optional property allOf[subschema #2]/items/items/has_been_promoted to the response with the 200 status

      response-optional-property-added

    • added the optional property allOf[subschema #2]/items/items/is_owner to the response with the 200 status

      response-optional-property-added

    • added the optional property allOf[subschema #2]/items/items/is_standard to the response with the 200 status

      response-optional-property-added

    • added the optional property allOf[subschema #2]/items/items/media_source/allOf[subschema #1: Pin media source]/oneOf[subschema #3: Video ID]/cover_image_content_type to the response with the 200 status

      response-optional-property-added

    • added the optional property allOf[subschema #2]/items/items/media_source/allOf[subschema #1: Pin media source]/oneOf[subschema #3: Video ID]/cover_image_data to the response with the 200 status

      response-optional-property-added

    • added the optional property allOf[subschema #2]/items/items/note to the response with the 200 status

      response-optional-property-added

    • added CreativeType to the allOf[subschema #2]/items/items/creative_type response property allOf list for the response status 200

      response-property-all-of-added

    • removed subschema #1: Creative Type from the allOf[subschema #2]/items/items/creative_type response property allOf list for the response status 200

      response-property-all-of-removed

    • added pin_url discriminator mapping keys to the allOf[subschema #2]/items/items/media_source/allOf[subschema #1: Pin media source]/ response property for the response status 200

      response-property-discriminator-mapping-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v5689b4b2676392410See the full diff
    • the query request parameter query became required

      request-parameter-became-required

    • added the pattern (?!^\d+$)^.+$ to the query request parameter query

      request-parameter-pattern-added

    • deleted the query request parameter board

      request-parameter-removed

    • deleted the query request parameter richtype

      request-parameter-removed

    • deleted the query request parameter rs

      request-parameter-removed

    • deleted the query request parameter topic_based

      request-parameter-removed

    • the security scope boards:read was added to the endpoint's security scheme pinterest_oauth2

      api-security-scope-added

    • the security scope boards:read_secret was added to the endpoint's security scheme pinterest_oauth2

      api-security-scope-added

    • the security scope pins:read was added to the endpoint's security scheme pinterest_oauth2

      api-security-scope-added

    • the security scope pins:read_secret was added to the endpoint's security scheme pinterest_oauth2

      api-security-scope-added

    • the security scope user_accounts:read was removed from the endpoint's security scheme pinterest_oauth2

      api-security-scope-removed

    • added the new optional query request parameter ad_account_id

      new-optional-request-parameter

    • added the optional property allOf[subschema #2]/items/items/creative_type to the response with the 200 status

      response-optional-property-added

    • added the optional property allOf[subschema #2]/items/items/media_source/allOf[subschema #1: Pin media source]/oneOf[subschema #1: Image Base64]/is_standard to the response with the 200 status

      response-optional-property-added

    • added the optional property allOf[subschema #2]/items/items/media_source/allOf[subschema #1: Pin media source]/oneOf[subschema #2: Image URL]/is_standard to the response with the 200 status

      response-optional-property-added

    • added the optional property allOf[subschema #2]/items/items/media_source/allOf[subschema #1: Pin media source]/oneOf[subschema #3: Video ID]/is_standard to the response with the 200 status

      response-optional-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog