Pins

List Pins

List pins for the workspace, newest first by default, with optional filters.

The X-Total-Count response header carries the number of pins matching the filters and search, so clients can page with limit and offset.

get/v1/pins

Request

  • Base URL: https://api.pinbridge.io (the document declares no server; this is the origin it was published from)
  • URL: https://api.pinbridge.io/v1/pins
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Query parameters

limitinteger
offsetinteger
qstring nullable

Case-insensitive search across title, description and link URL

sort'created_at_desc' | 'created_at_asc' | 'published_at_desc' | 'published_at_asc' | 'title_asc' | 'title_desc' | 'status_asc' | 'status_desc'

Sort order

account_idstring uuid nullable

Only pins for this Pinterest account

board_idstring nullable

Only pins targeting this board

status'queued' | 'deferred' | 'publishing' | 'published' | 'failed'

Pin status enum.

Only pins in this status

error_codestring nullable

Only failed pins with this error code

removedboolean nullable

true: only published pins that no longer exist on Pinterest; false: exclude them

sincestring date-time nullable

Only pins created at or after this ISO 8601 timestamp

untilstring date-time nullable

Only pins created before this ISO 8601 timestamp

Headers

x-api-keystring nullable
authorizationstring nullable

Response

Successful Response

idstring uuid required
workspace_idstring uuid required
pinterest_account_idstring uuid required
status'queued' | 'deferred' | 'publishing' | 'published' | 'failed' required

Pin status enum.

media_type'image' | 'video' required

Pin media type enum.

titlestring required
descriptionstring nullable
related_termsstring[] nullable
alt_textstring nullable
dominant_colorstring nullable
cover_image_urlstring nullable
link_urlstring nullable
media_urlstring required
image_urlstring required
asset_idstring uuid nullable
board_idstring required
pinterest_pin_idstring nullable
error_codestring nullable
error_messagestring nullable
idempotency_keystring required
created_atstring date-time required
updated_atstring date-time required
published_atstring date-time nullable
failed_atstring date-time nullable

When the pin failed; set only while status is failed and cleared by a retry, like error_code

removed_from_pinterest_atstring date-time nullable

When PinBridge found that this published pin no longer exists on Pinterest (deleted there by hand or with its board). The pin keeps status published; null means it is live or has not been checked.

Changes

No recorded changes to this operation across all 1 revision of this API.