Search pins by a given search term
Changed onThis endpoint is currently in beta and not available to all apps. Learn more.
Get the top 10 Pins by a given search term.
Request
- Base URLhttps://api.pinterest.com/v5
- AuthOAuth 2Authorization codehttps://www.pinterest.com/oauth/Token URLhttps://api.pinterest.com/v5/oauth/tokenScopesboards:read, pins:read
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
Search term to look up pins.
Two letter country code (ISO 3166-1 alpha-2)
Cursor used to fetch the next page of items
Search locale.
Max search result size
Response
The request has succeeded.
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
- breaking
the response's body type changed from no type to
objectfor status - info
removed
subschema #2from the response bodyallOflist 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
- breaking
- breaking
added to the
////response propertyoneOflist for the response status - info
removed
subschema #2from the////response propertyallOflist for the response status - info
added discriminator to
////response property for the response status
- breaking