List Pins on board
GET {{baseUrl}}/boards/:board_id/pins?bookmark=<string>&page_size=25&creative_types=SHOP_THE_PIN&creative_types=VIDEO&ad_account_id=15266090296&pin_metrics=false
Get a list of the Pins on a board owned by the operation user_account
- or on a group board that has been shared with this account.
- Optional: Business Access: Specify an adaccountid to use the owner of that adaccount as the "operation useraccount.
- By default, the
operation useraccount" is the token useraccount.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
bookmark | string | Cursor used to fetch the next page of items | |
page_size | number | Maximum number of items to include in a single page of the response. See documentation on <a href='/docs/getting-started/pagination/'>Pagination</a> for more information. | |
creative_types | string | Pin creative types filter. </p><strong>Note:</strong> SHOP_THE_PIN has been deprecated. Please use COLLECTION instead. | |
creative_types | string | Pin creative types filter. </p><strong>Note:</strong> SHOP_THE_PIN has been deprecated. Please use COLLECTION instead. | |
ad_account_id | number | Unique identifier of an ad account. | |
pin_metrics | boolean | Specify whether to return 90d and lifetime Pin metrics. Total comments and total reactions are only available with lifetime Pin metrics. If Pin was created before <code>2023-03-20</code> lifetime metrics will only be available for Video and Idea Pin formats. Lifetime metrics are available for all Pin formats since then. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"items":[],"bookmark":"\u003cstring\u003e"}