docs / pinterest

Pinterest API

base /pinterest/v19 endpoints

post/pinterest/v1/profile1 credit

public profile by username

Parameter		Allowed / range	Description
username	required	—	Pinterest username (the name in pinterest.com/<username>/).

Try in playground →

post/pinterest/v1/user_boards1 credit

public boards by username

Parameter		Allowed / range	Description
username	required	—	Pinterest username (the name in pinterest.com/<username>/).

Try in playground →

post/pinterest/v1/user_pins1 credit

public created/saved pins by username

Parameter		Allowed / range	Description
username	required	—	Pinterest username (the name in pinterest.com/<username>/).
section = _created	optional	_created · _saved	Which pin shelf to read (created vs saved). Other profile section slugs are also accepted as-is.
limit = 25	optional	1–	Page size — how many items to request per page (default 25). Use meta.bookmark / the bookmark param to page further.

Try in playground →

post/pinterest/v1/board_pins1 credit

public pins from a board

Parameter		Allowed / range	Description
board_url	optional	—	Full board URL (alternative to username + board).
username	optional	—	Pinterest username (the name in pinterest.com/<username>/).
board	optional	—	Board slug — the segment after the username in a board URL (also accepted as 'board_slug'). Combine with username, or pass board_url.
limit = 25	optional	1–	Page size — how many items to request per page (default 25). Use meta.bookmark / the bookmark param to page further.

Try in playground →

post/pinterest/v1/pin1 credit

public pin detail by pin_id or pin_url

Parameter		Allowed / range	Description
pin_id	optional	—	Numeric pin id (the digits in pinterest.com/pin/<pin_id>/). Provide pin_id OR pin_url.
pin_url	optional	—	Full pin URL (alternative to pin_id).

Try in playground →

post/pinterest/v1/search_pins1 credit

public pin search

Parameter		Allowed / range	Description
query	required	—	Free-text search query.
limit = 25	optional	1–	Page size — how many items to request per page (default 25). Use meta.bookmark / the bookmark param to page further.
bookmark	optional	—	Pagination cursor from a previous response's `bookmark`. Omit for page one.

Try in playground →

post/pinterest/v1/search_users1 credit

public user search

Parameter		Allowed / range	Description
query	required	—	Free-text search query.
limit = 25	optional	1–	Page size — how many items to request per page (default 25). Use meta.bookmark / the bookmark param to page further.
bookmark	optional	—	Pagination cursor from a previous response's `bookmark`. Omit for page one.

Try in playground →

post/pinterest/v1/search_boards1 credit

public board search

Parameter		Allowed / range	Description
query	required	—	Free-text search query.
limit = 25	optional	1–	Page size — how many items to request per page (default 25). Use meta.bookmark / the bookmark param to page further.
bookmark	optional	—	Pagination cursor from a previous response's `bookmark`. Omit for page one.

Try in playground →

post/pinterest/v1/related_pins1 credit

related pins from a public pin page

Parameter		Allowed / range	Description
pin_id	optional	—	Numeric pin id (the digits in pinterest.com/pin/<pin_id>/). Provide pin_id OR pin_url.
pin_url	optional	—	Full pin URL (alternative to pin_id).

Try in playground →

Example request · profile

curl -X POST https://api.reefapi.com/pinterest/v1/profile \
  -H "x-api-key: $REEF_KEY" \
  -H "content-type: application/json" \
  -d '{"username":"nike"}'

Response shape

{
  "ok": true,
  "data": { /* the result */ },
  "meta": {
    "latency_ms": 240,
    "record_count": 12,
    "completeness_pct": 100
  },
  "error": null
}