Get Pin
Get a Pin owned by the "operation user_account" - or on a group board that has been shared with this account.
- By default, the "operation user_account" is the token user_account.
Optional: Business Access: Specify an ad_account_id (obtained via List ad accounts) to use the owner of that ad_account as the "operation user_account". In order to do this, the token user_account must have one of the following Business Access roles on the ad_account:
- For Pins on public or protected boards: Owner, Admin, Analyst, Campaign Manager.
- For Pins on secret boards: Owner, Admin.
Path parameters
Query parameters
Unique identifier of an ad account.
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 2023-03-20 lifetime metrics will only be available for Video and Idea Pin formats. Lifetime metrics are available for all Pin formats since then.
Response
The request has succeeded.
Example response
{
"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 20 of the 29 revisions of this API.182147
- ▲
removed the required property
idfrom the response with the200statusresponse-required-property-removed
- ●
removed the optional property
board_idfrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
board_ownerfrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
board_section_idfrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
created_atfrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
creative_typefrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
dominant_colorfrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
has_been_promotedfrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
is_ownerfrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
is_standardfrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
mediafrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
parent_pin_idfrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
pin_metricsfrom the response with the200statusresponse-optional-property-removed
- ○
added
PinBaseto the response bodyallOflist for the response status200response-body-all-of-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
notefrom the response with the200statusresponse-optional-property-removed
- ●
added the new
COLLAGEenum value to thecreative_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 thecreative_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 thecreative_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 the pattern
^\d+$to thepathrequest parameterpin_idrequest-parameter-pattern-added
- ▲
added
PinMediaWithImagePinMediaWithVideoPinMediaWithImagesPinMediaWithVideosPinMediaWithImageAndVideoto themedia/allOf[subschema #1: Pin media -> subschema #1: Pin media response object.]/response propertyoneOflist for the response status200response-property-one-of-added
- ▲
the
board_ownerresponse's property type/format changed fromobject/to/for status200response-property-type-changed
- ▲
the
creative_typeresponse's property type/format changed fromstring/to/for status200response-property-type-changed
- ▲
the
mediaresponse's property type/format changed fromobject/to/for status200response-property-type-changed
- ●
removed the optional property
is_removablefrom the response with the200statusresponse-optional-property-removed
- ●
removed the optional property
product_tagsfrom the response with the200statusresponse-optional-property-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
429response-non-success-status-added
- ○
the response optional property
idbecame not read-only for the status200response-optional-property-became-not-read-only
- ○
the response optional property
is_standardbecame read-only for the status200response-optional-property-became-read-only
- ○
the response optional property
pin_metricsbecame read-only for the status200response-optional-property-became-read-only
- ○
removed the optional write-only property
media_sourcefrom the response with the200statusresponse-optional-write-only-property-removed
- ○
removed
PinMediaBasesubschema #2from themedia/allOf[subschema #1: Pin media -> subschema #1: Pin media response object.]/response propertyallOflist for the response status200response-property-all-of-removed
- ○
the response property
idbecame required for the status200response-property-became-required
- ○
added discriminator to
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
is_removableto the response with the200statusresponse-optional-property-added
- ○
added the optional property
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
media/allOf[subschema #1: Pin media]/media_typefrom the response with the200statusresponse-optional-property-removed
- ○
added the optional property
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 themedia/allOf[subschema #1: Pin media]/response propertyallOflist for the response status200response-property-all-of-added
- ○
removed discriminator from
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 endpoint scheme security
client_credentialswas added to the APIapi-security-added
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ○
- ○
added the new optional
queryrequest parameterpin_metricsnew-optional-request-parameter
- ○
added the optional property
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
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
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 themedia_source/allOf[subschema #1: Pin media source]/response propertyoneOflist for the response status200response-property-one-of-added
- ○
added the optional property
has_been_promotedto the response with the200statusresponse-optional-property-added
- ○
added the optional property
is_ownerto the response with the200statusresponse-optional-property-added
- ○
added the optional property
is_standardto the response with the200statusresponse-optional-property-added
- ○
added the optional property
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
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
noteto the response with the200statusresponse-optional-property-added
- ○
added
CreativeTypeto thecreative_typeresponse propertyallOflist for the response status200response-property-all-of-added
- ○
removed
subschema #1: Creative Typefrom thecreative_typeresponse propertyallOflist for the response status200response-property-all-of-removed
- ○
added
pin_urldiscriminator mapping keys to themedia_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
- ▲
- ○
added the optional property
creative_typeto the response with the200statusresponse-optional-property-added
- ○
added the optional property
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
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
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
- ○