Social platforms

List pins on a Pinterest board · Pinterest API

GET/pinterest/users/{username}/boards/{board}/pins

$min $0.003

Returns the public pins on a Pinterest board with images, titles, links and save counts. Paginate with `cursor`.

Add to Claude Read the docs

Using ChatGPT, Claude Code or another client? See the setup steps

Request

curl https://api.unifapi.com/pinterest/users/{username}/boards/{board}/pins \
  -H "Authorization: Bearer $UNIFAPI_KEY"

Parameters

usernamepathrequired: Pinterest username of the board owner.
boardpathrequired: Board slug, as in pinterest.com/{username}/{board}.
cursorquery: Opaque pagination cursor from a previous response's `pagination.next_cursor`. Omit for the first page.
: The parameter for this Pinterest operation. Use the URL-visible slug or id described in the docs.

Overview

This operation is part of the Pinterest API in the social platforms category. It uses the same Bearer token, request tracing, error model, and billing envelope as every UnifAPI endpoint, so agents can switch between platforms without custom per-vendor glue code.

Use it when a workflow needs Pinterest public data alongside other social networks, but should still keep one API key, one account balance, and one predictable JSON contract.

Common agent workflows

Resolve a public Pinterest identity into structured profile metadata for enrichment agents.
Refresh creator, company, or account snapshots without managing source-specific response shapes.
Give an AI agent a stable Pinterest data source without building a per-platform integration.
Normalize Pinterest responses into the same UnifAPI envelope used across the catalog.

Response shape

Unified envelope, platform-native fields

List-style responses return `data` as an array of top-level records plus optional `pagination` for continuation tokens or cursors.
The operation has a 3 credits ($0.003) minimum charge, so `billing.records_charged` can be higher than the visible records returned.
If the workspace balance cannot cover every result, the response can be truncated and `billing.truncated_due_to_balance` tells the caller why.

Response status codes

200400401402404429500502503

Billing

This operation charges 1 credit per billable record, with a 3 credits ($0.003) operation minimum. Public responses include billing metadata with credits charged, records charged, and remaining workspace balance. Incorrect Credit deductions caused by platform failures can be restored as billing corrections.

Errors and retries

Authentication, validation, rate-limit, not-found, and provider errors use the unified UnifAPI error format. Agents should log `request_id`, retry only retryable failures, and treat invalid API keys, disabled keys, and expired keys as the same public `unauthorized` error type.

Response fields

Fields on each record in data

A successful List pins on a Pinterest board call returns data as an array; each record carries these fields (12 of 13 shown — the docs list the full schema).

idstring | null: Pinterest pin id.
urlstring | null: Canonical public pin URL when available.
titlestring | null: Pin title when available.
descriptionstring | null: Pin description when available.
linkstring | null: Outbound destination link when available.
domainstring | null: Destination domain when available.
dominant_colorstring | null: Dominant image color when available.
created_atnumber | null: When the pin was created, when available. Unix seconds.
imageobject | null: Primary (original) image when available.
pinnerobject | null: User who pinned this item when available.
boardobject | null: Board this pin belongs to when available.
save_countnumber | null: Save count when available.

Related endpoints

More Pinterest operations

Combine endpoints from the same platform, then join the results with other UnifAPI categories without changing authentication or response parsing.

GET/pinterest/pins/{id}