---
title: "List Pins"
method: GET
path: "/v1/pins"
tags: ["Pins"]
---

# List Pins

`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

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`.

## Query parameters

- `limit` integer
- `offset` integer
- `q` string, 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_id` string, uuid, nullable: Only pins for this Pinterest account
- `board_id` string, nullable: Only pins targeting this board
- `status` 'queued' | 'deferred' | 'publishing' | 'published' | 'failed': Pin status enum.
- `error_code` string, nullable: Only failed pins with this error code
- `removed` boolean, nullable: true: only published pins that no longer exist on Pinterest; false: exclude them
- `since` string, date-time, nullable: Only pins created at or after this ISO 8601 timestamp
- `until` string, date-time, nullable: Only pins created before this ISO 8601 timestamp

## Headers

- `x-api-key` string, nullable
- `authorization` string, nullable

## Response `200`

Successful Response

- PinResponse[]
  - `id` string, uuid, required
  - `workspace_id` string, uuid, required
  - `pinterest_account_id` string, uuid, required
  - `status` 'queued' | 'deferred' | 'publishing' | 'published' | 'failed', required: Pin status enum.
  - `media_type` 'image' | 'video', required: Pin media type enum.
  - `title` string, required
  - `description` string, nullable
  - `related_terms` string[], nullable
  - `alt_text` string, nullable
  - `dominant_color` string, nullable
  - `cover_image_url` string, nullable
  - `link_url` string, nullable
  - `media_url` string, required
  - `image_url` string, required
  - `asset_id` string, uuid, nullable
  - `board_id` string, required
  - `pinterest_pin_id` string, nullable
  - `error_code` string, nullable
  - `error_message` string, nullable
  - `idempotency_key` string, required
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required
  - `published_at` string, date-time, nullable
  - `failed_at` string, date-time, nullable: When the pin failed; set only while status is failed and cleared by a retry, like error_code
  - `removed_from_pinterest_at` string, 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.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/pinbridge/apis/pinbridge-api.md) · [All operations](https://skmtc.dev/pinbridge/apis/pinbridge-api/llms.txt) · [OpenAPI document](https://skmtc.dev/pinbridge/apis/pinbridge-api/revisions/b17603589d01?raw)