Sign in
search

Search pins by a given search term

This endpoint is currently in beta and not available to all apps. Learn more.

Get the top 10 Pins by a given search term.

get/search/partner/pins

Query parameters

termstring required

Search term to look up pins.

country_codestring required

Two letter country code (ISO 3166-1 alpha-2)

bookmarkstring

Cursor used to fetch the next page of items

localestring

Search locale.

limitinteger

Max search result size

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

Changes

Changed in 5 of the 29 revisions of this API.3113

  • 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 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 404

      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

  • v57d64d863909a12See 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

    • ○

      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

    • ○

      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

  • 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/id 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

  • v5f9321315766f1See the full diff
    • ▲

      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

  • v57529b464d5cb1See the full diff
    • ○

      endpoint added

      endpoint-added

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