Skip to content
Browsabledocs
↑ ↓ to navigate · Enter to openQuick links
Staging API reference · Requests use https://api-ingress-worker-staging.browsable-staging.workers.dev
Documentation Pinterest Board API
Markdown ↗
Pinterest APIs

Pinterest Board API

Scrape pins from an accessible Pinterest board using your connected Pinterest account.

POST/v1/pinterest/board
Authenticate every request

Send Authorization: Bearer YOUR_API_KEY. Get an API key →

Connected website account required

Requires a connected pinterest.com account. Browsable automatically uses a saved connection on your team when one is available.

If none is available, HTTP 428 includes a hosted_url. Complete sign-in there, then retry. Connect an account →

Parameters

Send these fields in a flat JSON body. Add _run to choose execution options.

board_urlstringRequired

URL of the Pinterest board to scrape. The board must be accessible to the connected Pinterest account.

limitintegerOptional

Maximum number of pins to return in this page. Default: 100. Minimum: 1. Maximum: 250.

cursorstringOptional

Offset cursor returned by the previous page. Omit it to start from the first pin.

Response

Every response describes a run. Read result once run_status is succeeded.

run_id
The run to track. Keep it when contacting support.
run_status
Queued, running, waiting for sign-in, succeeded, or failed. Check this even after an HTTP 200.
status_url
Poll this URL while the run is pending. Keep the same run instead of starting another request.
result
The endpoint’s returned data. The example is illustrative; actual fields may be empty or unavailable.
error
On failure, inspect its code, message, retryable and action fields.
View the complete output schema
JSON
{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "success",
    "board",
    "count",
    "pins",
    "limit",
    "pagination"
  ],
  "properties": {
    "pins": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "id",
          "url",
          "title",
          "description",
          "alt_text",
          "image_url",
          "image_urls",
          "link_url",
          "is_video",
          "pinner_username",
          "pinner_name"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "url": {
            "type": "string"
          },
          "title": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "alt_text": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "is_video": {
            "type": "boolean"
          },
          "link_url": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "image_url": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "image_urls": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "description": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "pinner_name": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "pinner_username": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "additionalProperties": false
      }
    },
    "board": {
      "type": "object",
      "required": [
        "url",
        "name",
        "owner",
        "privacy"
      ],
      "properties": {
        "url": {
          "type": "string"
        },
        "name": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "owner": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "privacy": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "additionalProperties": false
    },
    "count": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "success": {
      "const": true
    },
    "pagination": {
      "type": "object",
      "required": [
        "has_next_page",
        "next_cursor"
      ],
      "properties": {
        "next_cursor": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "has_next_page": {
          "type": "boolean"
        }
      },
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}
View a polled run response
JSON
{
  "run_id": "00000000-0000-4000-8000-000000000001",
  "task_key": "pinterest-board",
  "task_name": "Pinterest Board API",
  "run_status": "succeeded",
  "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001",
  "result": {
    "pins": [
      {
        "id": "id-1",
        "url": "https://example.com/item-1",
        "title": "Stylish Shoreditch Loft with Balcony",
        "alt_text": "Sample alt_text 1",
        "is_video": true,
        "link_url": "https://example.com/item-1",
        "image_url": "https://example.com/item-1",
        "image_urls": [
          "https://images.example.com/image_urls-1.jpg"
        ],
        "description": "Sample description 1",
        "pinner_name": "Stylish Shoreditch Loft with Balcony",
        "pinner_username": "Stylish Shoreditch Loft with Balcony"
      }
    ],
    "board": {
      "url": "https://example.com/item-1",
      "name": "Stylish Shoreditch Loft with Balcony",
      "owner": "sample",
      "privacy": "sample"
    },
    "count": 1,
    "limit": 1,
    "success": true,
    "pagination": {
      "next_cursor": "cursor-page-1",
      "has_next_page": true
    }
  },
  "error": null
}

Errors & retries

  • 400Fix the fields listed in errors before retrying.
  • 428Connect the requested website account using the returned sign-in link.
  • 429Wait for the duration in Retry-After.
  • 5xxRetry transient failures with backoff. Keep the request ID.

A failed run has its own error inside the response. Retry it only when error.retryable is true.

Validation, pagination and recovery →

More examples

Async request with polling
RUN=$(curl -s -X POST "https://api-ingress-worker-staging.browsable-staging.workers.dev/v1/pinterest/board" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"board_url":"https://example.com/item-1"}')

RUN_ID=$(echo "$RUN" | jq -er '.run_id // empty') || { echo "$RUN" >&2; exit 1; }
POLL_DELAY=3

while true; do
  RESULT=$(curl -s -H "Authorization: Bearer YOUR_API_KEY" "https://api-ingress-worker-staging.browsable-staging.workers.dev/v1/runs/$RUN_ID")
  STATUS=$(echo "$RESULT" | jq -r '.run_status')
  if [[ "$STATUS" =~ ^(succeeded|failed|errored|cancelled|canceled|expired)$ ]]; then
    echo "$RESULT"
    break
  fi
  sleep "$(awk "BEGIN { print $POLL_DELAY * (0.9 + ($RANDOM % 21) / 100) }")"
  POLL_DELAY=$((POLL_DELAY < 30 ? POLL_DELAY * 2 : 30))
  [ "$POLL_DELAY" -gt 30 ] && POLL_DELAY=30
done
Wait-for-results request
curl -X POST "https://api-ingress-worker-staging.browsable-staging.workers.dev/v1/pinterest/board" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"board_url":"https://example.com/item-1","_run":{"async":false}}'
Canonical & compatibility routes

You can also send the same JSON body to /v1/tasks/pinterest-board/runs.