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.
Query parameters
Unique identifier of an ad account.
Search query. Can contain pin description keywords or comma-separated pin IDs.
Cursor used to fetch the next page of items
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"
}
}
},
"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
- ▲
the response's body type/format changed from
/toobject/for status200response-body-type-changed
- ○
removed
Paginatedsubschema #2from the response bodyallOflist for the response status200response-body-all-of-removed
- ○
added the non-success response with the status
400response-non-success-status-added
- ○
added the non-success response with the status
401response-non-success-status-added
- ○
added the non-success response with the status
403response-non-success-status-added
- ○
added the non-success response with the status
429response-non-success-status-added
- ○
added the optional property
bookmarkto the response with the200statusresponse-optional-property-added
- ○
added the required property
itemsto the response with the200statusresponse-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/notefrom the response with the200statusresponse-optional-property-removed
- ●
added the new
COLLAGEenum value to theallOf[subschema #2]/items/items/creative_type/allOf[subschema #1: CreativeType enum used ads]/response property for the response status200response-property-enum-value-added
- ●
added the new
MAX_WIDTH_REGULAR_COLLECTIONenum value to theallOf[subschema #2]/items/items/creative_type/allOf[subschema #1: CreativeType enum used ads]/response property for the response status200response-property-enum-value-added
- ●
added the new
MAX_WIDTH_VIDEO_COLLECTIONenum value to theallOf[subschema #2]/items/items/creative_type/allOf[subschema #1: CreativeType enum used ads]/response property for the response status200response-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
- ●
- ▲
added
PinMediaWithImagePinMediaWithVideoPinMediaWithImagesPinMediaWithVideosPinMediaWithImageAndVideoto theallOf[subschema #2]/items/items/media/allOf[subschema #1: Pin media -> subschema #1: Pin media response object.]/response propertyoneOflist for the response status200response-property-one-of-added
- ▲
the
allOf[subschema #2]/items/items/board_ownerresponse's property type/format changed fromobject/to/for status200response-property-type-changed
- ▲
the
allOf[subschema #2]/items/items/creative_typeresponse's property type/format changed fromstring/to/for status200response-property-type-changed
- ▲
the
allOf[subschema #2]/items/items/mediaresponse's property type/format changed fromobject/to/for status200response-property-type-changed
- ●
removed the optional property
allOf[subschema #2]/items/items/is_removablefrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
allOf[subschema #2]/items/items/product_tagsfrom the response with the200statusresponse-optional-property-removed
- ○
the response optional property
allOf[subschema #2]/items/items/idbecame not read-only for the status200response-optional-property-became-not-read-only
- ○
the response optional property
allOf[subschema #2]/items/items/is_standardbecame read-only for the status200response-optional-property-became-read-only
- ○
the response optional property
allOf[subschema #2]/items/items/pin_metricsbecame read-only for the status200response-optional-property-became-read-only
- ○
removed the optional write-only property
allOf[subschema #2]/items/items/media_sourcefrom the response with the200statusresponse-optional-write-only-property-removed
- ○
removed
PinMediaBasesubschema #2from theallOf[subschema #2]/items/items/media/allOf[subschema #1: Pin media -> subschema #1: Pin media response object.]/response propertyallOflist for the response status200response-property-all-of-removed
- ○
the response property
allOf[subschema #2]/items/items/idbecame required for the status200response-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 status200response-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_removableto the response with the200statusresponse-optional-property-added
- ○
added the optional property
allOf[subschema #2]/items/items/product_tagsto the response with the200statusresponse-optional-property-added
This revision also has 2 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/media/allOf[subschema #1: Pin media]/media_typefrom the response with the200statusresponse-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_timeto the response with the200statusresponse-optional-property-added
- ○
added
PinMediaBasesubschema #2to theallOf[subschema #2]/items/items/media/allOf[subschema #1: Pin media]/response propertyallOflist for the response status200response-property-all-of-added
- ○
removed discriminator from
allOf[subschema #2]/items/items/media/allOf[subschema #1: Pin media]/response property for the response status200response-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/toobject/for status200response-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_metricsto the response with the200statusresponse-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_linkto the response with the200statusresponse-optional-property-added
- ○
- ▲
the response property
allOf[subschema #2]/items/items/media_source/allOf[subschema #1: Pin media source]/oneOf[subschema #3: Video ID]/cover_image_urlbecame optional for the status200response-property-became-optional
- ▲
added
PinMediaSourcePinURLto theallOf[subschema #2]/items/items/media_source/allOf[subschema #1: Pin media source]/response propertyoneOflist for the response status200response-property-one-of-added
- ○
removed the pattern
(?!^\d+$)^.+$from thequeryrequest parameterqueryrequest-parameter-pattern-removed
- ○
added the optional property
allOf[subschema #2]/items/items/has_been_promotedto the response with the200statusresponse-optional-property-added
- ○
added the optional property
allOf[subschema #2]/items/items/is_ownerto the response with the200statusresponse-optional-property-added
- ○
added the optional property
allOf[subschema #2]/items/items/is_standardto the response with the200statusresponse-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_typeto the response with the200statusresponse-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_datato the response with the200statusresponse-optional-property-added
- ○
added the optional property
allOf[subschema #2]/items/items/noteto the response with the200statusresponse-optional-property-added
- ○
added
CreativeTypeto theallOf[subschema #2]/items/items/creative_typeresponse propertyallOflist for the response status200response-property-all-of-added
- ○
removed
subschema #1: Creative Typefrom theallOf[subschema #2]/items/items/creative_typeresponse propertyallOflist for the response status200response-property-all-of-removed
- ○
added
pin_urldiscriminator mapping keys to theallOf[subschema #2]/items/items/media_source/allOf[subschema #1: Pin media source]/response property for the response status200response-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
- ▲
- ▲
the
queryrequest parameterquerybecame requiredrequest-parameter-became-required
- ▲
added the pattern
(?!^\d+$)^.+$to thequeryrequest parameterqueryrequest-parameter-pattern-added
- ●
deleted the
queryrequest parameterboardrequest-parameter-removed
- ●
deleted the
queryrequest parameterrichtyperequest-parameter-removed
- ●
deleted the
queryrequest parameterrsrequest-parameter-removed
- ●
deleted the
queryrequest parametertopic_basedrequest-parameter-removed
- ○
the security scope
boards:readwas added to the endpoint's security schemepinterest_oauth2api-security-scope-added
- ○
the security scope
boards:read_secretwas added to the endpoint's security schemepinterest_oauth2api-security-scope-added
- ○
the security scope
pins:readwas added to the endpoint's security schemepinterest_oauth2api-security-scope-added
- ○
the security scope
pins:read_secretwas added to the endpoint's security schemepinterest_oauth2api-security-scope-added
- ○
the security scope
user_accounts:readwas removed from the endpoint's security schemepinterest_oauth2api-security-scope-removed
- ○
added the new optional
queryrequest parameterad_account_idnew-optional-request-parameter
- ○
added the optional property
allOf[subschema #2]/items/items/creative_typeto the response with the200statusresponse-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_standardto the response with the200statusresponse-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_standardto the response with the200statusresponse-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_standardto the response with the200statusresponse-optional-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲