PIpinterest
search

Search user's Pins

Changed on

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

Request

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

  • v5b698c180678aRevision changes
    • breaking

      the response's body type changed from no type to object for status

    • info

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

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

  • v514c297539b64Revision changes
    • warning

      removed the optional property /// from the response with the status

    • warning

      added the new COLLAGE enum value to the //// response property for the response status

    • warning

      added the new MAX_WIDTH_REGULAR_COLLECTION enum value to the //// response property for the response status

    • warning

      added the new MAX_WIDTH_VIDEO_COLLECTION enum value to the //// response property for the response status