/v1/pinterest/user/boards
User Boards
Get a user's boards
| Credit cost | Default: 1 credit How charges are determinedCost is decided per call, not per endpoint: the same operation can cost different amounts depending on what it returns. A call that fails costs 0 credits. A result served from cache costs 0 credits. `default` is the cost when no rule matches. Rules are evaluated in order and the first whose conditions all hold wins. A `when` condition is one of: `param` (the request parameter is true), `outcome` (the classifier's outcome), `empty` / `nonEmpty` (a response field is empty and absent, or a non-empty array or string), `flag` (a response field is exactly true). A cost of `{ perStartedMinute: n, of: [fields] }` is n x max(1, ceil(seconds / 60)), so even a short result bills at least one minute. |
|---|---|
| Cache support | Not specified in the published contract. |
| Pagination | No explicit pagination metadata in the published contract. Consult the parameters and response fields below. |
Parameters
| Name | Location / required | Schema |
|---|---|---|
handlePinterest username, e.g. broadstbullycom, not a profile URL. | query / required |
|
trimSet true for a trimmed response. | query / optional |
|
Request examples
Replace placeholder values and supply your own API key. For operations with a request body, populate the body using the schema above.
cURL
curl --request GET 'https://api.fetchproof.com/v1/pinterest/user/boards?handle=YOUR_HANDLE' \
--header 'x-api-key: YOUR_API_KEY'JavaScript
const response = await fetch("https://api.fetchproof.com/v1/pinterest/user/boards?handle=YOUR_HANDLE", {
method: 'GET',
headers: { 'x-api-key': process.env.FETCHPROOF_API_KEY }
});
console.log(await response.text());Python
import os
import requests
response = requests.get("https://api.fetchproof.com/v1/pinterest/user/boards?handle=YOUR_HANDLE",
headers={"x-api-key": os.environ["FETCHPROOF_API_KEY"]})
print(response.text)Responses
200Success. Envelope: success / credits_remaining / credits_charged.
application/json
object
successrequired
boolean
credits_remainingrequired
integer
credits_chargedrequired
integer
boardsrequired
array
Array items
object
node_idoptional
string
collaborating_usersoptional
array
namerequired
string
owneroptional
object
node_idrequired
string
is_private_profilerequired
boolean
ads_only_profile_siterequired
null
typerequired
string
is_default_imagerequired
boolean
explicitly_followed_by_merequired
boolean
is_verified_merchantrequired
boolean
verified_identityrequired
object
verifiedoptional
boolean
full_namerequired
string
image_medium_urlrequired
string
idrequired
string
domain_verifiedrequired
boolean
is_partnerrequired
boolean
usernamerequired
string
is_ads_only_profilerequired
boolean
follower_countoptional
integer
board_order_modified_atoptional
string
descriptionrequired
string
collaborated_by_meoptional
boolean
created_atrequired
string
urlrequired
string
allow_homefeed_recommendationsoptional
boolean
collaborator_requests_enabledoptional
boolean
followed_by_meoptional
boolean
collaborator_countoptional
integer
is_ads_onlyoptional
boolean
pin_countrequired
integer
imagesoptional
object
170xoptional
array
Array items
object
urlrequired
string
widthrequired
integer
heightrequired
integer
dominant_colorrequired
string
236xrequired
array
Array items
object
urlrequired
string
widthrequired
integer
heightrequired
integer
dominant_colorrequired
string
idrequired
string
should_show_more_ideasoptional
boolean
typeoptional
string
accessoptional
array
cover_pinoptional
object
pin_idrequired
string
image_signaturerequired
string
timestamprequired
integer
cropoptional
array
Array items
integer
sizeoptional
array
Array items
integer
scaleoptional
integer
image_urloptional
string
custom_coveroptional
boolean
image_sizeoptional
array
Array items
integer
has_custom_coveroptional
boolean
viewer_collaborator_join_requestedoptional
boolean
section_countoptional
integer
privacyoptional
string
follower_countrequired
integer
should_show_board_collaboratorsoptional
boolean
image_cover_urloptional
string
image_cover_hd_urlrequired
string
event_dateoptional
null
event_start_dateoptional
null
cover_imagesoptional
object
200x150required
object
urlrequired
string
widthrequired
integer
heightrequired
integer
222xoptional
object
urlrequired
string
widthrequired
integer
heightrequired
null
236xoptional
object
urlrequired
string
widthrequired
integer
heightrequired
null
place_saves_countoptional
integer
archived_by_me_atoptional
null
tracking_paramsoptional
string
should_show_shop_feedoptional
boolean
is_temporarily_disabledoptional
boolean
is_collaborativeoptional
boolean
board_vaseoptional
array
Array items
object
textrequired
string
linkrequired
string
typerequired
string
cursorrequired
string