Search user's Pins
GET {{baseUrl}}/search/pins?ad_account_id=15266090296&query=<string>&bookmark=<string>
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 adaccountid to use the owner of that adaccount as the "operation useraccount". See Understanding Business Access for more information.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
ad_account_id | number | Unique identifier of an ad account. | |
query | string | (Required) Search query. Can contain pin description keywords or comma-separated pin IDs. | |
bookmark | string | Cursor used to fetch the next page of items |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"items":[{"id":"70734","created_at":"\u003cdateTime\u003e","link":"\u003cstring\u003e","title":"\u003cstring\u003e","description":"\u003cstring\u003e","dominant_color":"\u003cstring\u003e","alt_text":"\u003cstring\u003e","creative_type":"CAROUSEL","board_id":"618","board_section_id":"079822","board_owner":{"username":"\u003cstring\u003e"},"is_owner":"\u003cboolean\u003e","media":{"media_type":"\u003cstring\u003e"},"media_source":{"source_type":"image_base64","content_type":"image/png","data":"48NLPhC5bn","is_standard":true},"parent_pin_id":"104","is_standard":"\u003cboolean\u003e","has_been_promoted":"\u003cboolean\u003e","note":"\u003cstring\u003e","pin_metrics":{}},{"id":"57722","created_at":"\u003cdateTime\u003e","link":"\u003cstring\u003e","title":"\u003cstring\u003e","description":"\u003cstring\u003e","dominant_color":"\u003cstring\u003e","alt_text":"\u003cstring\u003e","creative_type":"QUIZ","board_id":"190000","board_section_id":"5371750","board_owner":{"username":"\u003cstring\u003e"},"is_owner":"\u003cboolean\u003e","media":{"media_type":"\u003cstring\u003e"},"media_source":{"source_type":"image_base64","content_type":"image/png","data":"efC","is_standard":true},"parent_pin_id":"61104","is_standard":"\u003cboolean\u003e","has_been_promoted":"\u003cboolean\u003e","note":"\u003cstring\u003e","pin_metrics":{}}],"bookmark":"\u003cstring\u003e"}