> ## Documentation Index
> Fetch the complete documentation index at: https://docs.socq.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Pinterest Board Pins

> Get the pins saved to a Pinterest board.

# Pinterest Board Pins

Get the pins inside a Pinterest board, in the order the board shows them. Each pin includes its title or description, the account that saved it, the full-size image and its pin URL. Point it at a curated board in your niche to collect reference images, track what a competitor keeps adding to a seasonal board, or build a mood board dataset in one pass.

```json theme={"dark"}
{
  "urls": [
    "https://www.pinterest.com/lizmrodgers/moms-night/"
  ],
  "results_limit": 50
}
```

Provide Pinterest board URLs in urls, using /{username}/{board}/. results\_limit applies to each board, defaults to 50 and accepts integers from 1 to 1000. Pins come back in the order the board shows them, and each pin returned costs 0.5 credits.

## Standard Result Fields

Task results use the stable SocQ fields below. Source-specific field names and formats are normalized without inferring or enriching values that the source did not provide. To request a smaller field set, use `fields` for MCP queries, `_result_fields` for typed tools, or `--result-fields` in the CLI. Declared fields remain present when their value is `null`.

| Field | Type | Nullable | Description |
| - | - | - | - |
| `id` | `string` | Yes | Unique identifier for this result item. |
| `platform` | `string` | No | Platform the result belongs to, such as `instagram` or `linkedin`. |
| `resource` | `string` | No | SocQ resource represented by the result, such as `videos` or `comments`. |
| `type` | `string` | No | Category of the result item, such as `video`, `post`, or `comment`. |
| `url` | `string` | Yes | Public URL of the result item when available. |
| `published_at` | `string` | Yes | Time the source item was published, in ISO 8601 format when available. |
| `collected_at` | `string` | No | Time SocQ collected or processed this result, in ISO 8601 format. |
| `text` | `string` | Yes | Post body, caption, or message. |
| `author` | `object` | Yes | Author or publisher of the content. |
| `author.id` | `string` | Yes | Unique identifier of the author. |
| `author.username` | `string` | Yes | Public username or handle of the account. |
| `author.name` | `string` | Yes | Display name of the author. |
| `author.url` | `string` | Yes | Public URL of the author when available. |
| `author.avatar_url` | `string` | Yes | URL of the account avatar image. |
| `author.is_verified` | `boolean` | Yes | Whether the account is verified on the platform. |
| `author.is_private` | `boolean` | Yes | Whether the account is private. |
| `metrics` | `object` | Yes | Counters and measurements available for the result item. |
| `metrics.likes_count` | `integer` | Yes | Number of likes. |
| `metrics.comments_count` | `integer` | Yes | Number of comments. |
| `metrics.shares_count` | `integer` | Yes | Number of shares or reposts. |
| `metrics.views_count` | `integer` | Yes | Number of views reported by the platform. |
| `media` | `array<object>` | Yes | Images, videos, or other media attached to the result. |
| `media.type` | `string` | Yes | Media kind, such as `image` or `video`. |
| `media.url` | `string` | Yes | URL of the media asset. |
| `media.thumbnail_url` | `string` | Yes | URL of the media preview image. |
| `media.width` | `integer` | Yes | Media width in pixels. |
| `media.height` | `integer` | Yes | Media height in pixels. |
| `media.duration_seconds` | `number` | Yes | Media duration in seconds. |
| `hashtags` | `array<string>` | Yes | Hashtags associated with the content, without changing their source spelling. |
| `mentions` | `array<string>` | Yes | Accounts mentioned in the content. |

The following example shows the response format for a completed task. Actual data depends on your query.

## Completed Task Response

```json theme={"dark"}
{
  "code": 200,
  "data": {
    "task_id": "example-pinterest-board",
    "status": "succeeded",
    "public_id": "pinterest/board",
    "result_count": 1,
    "credits_amount": 0.5,
    "results": {
      "limit": 50,
      "next_cursor": null,
      "has_more": false,
      "schema_id": "post",
      "schema_version": "1.0",
      "items": [
        {
          "id": "e1_AfqPShz5t2Nv6-ZFexV_9XCwKVhdE2-2Hcm7iQWj-m0sopPAoDY",
          "platform": "pinterest",
          "resource": "board",
          "type": "pin",
          "url": "https://www.pinterest.com/pin/e1_AfqPShz5t2Nv6-ZFexV_9XCwKVhdE2-2Hcm7iQWj-m0sopPAoDY/",
          "published_at": null,
          "collected_at": "2026-11-17T14:40:58.610847Z",
          "text": "👼",
          "author": {
            "id": "63895025871749374",
            "username": "lizmrodgers",
            "name": "Liz Rodgers - DIY | Home Decor",
            "url": "https://www.pinterest.com/lizmrodgers/",
            "avatar_url": "https://i.pinimg.com/75x75_RS/c2/0e/62/c20e628451b24267c68924d01e42c997.jpg",
            "is_verified": null,
            "is_private": null
          },
          "metrics": null,
          "media": [
            {
              "type": "image",
              "url": "https://i.pinimg.com/originals/40/6e/97/406e979d4519d9fe0b6fd0cb2143e14b.jpg",
              "thumbnail_url": "https://i.pinimg.com/236x/40/6e/97/406e979d4519d9fe0b6fd0cb2143e14b.jpg",
              "width": 676,
              "height": 1200,
              "duration_seconds": null
            }
          ],
          "hashtags": null,
          "mentions": null
        }
      ]
    }
  }
}
```


## OpenAPI

````yaml api-manual/agent-api/agent-api.json POST /v1/pinterest/board
openapi: 3.1.0
info:
  title: SocQ Agent API
  version: v1-87892a6484c2
  description: Asynchronous social data API generated from the SocQ Capability Registry.
servers:
  - url: https://api.socq.ai
security: []
paths:
  /v1/pinterest/board:
    post:
      tags:
        - pinterest
      summary: Pinterest Board Pins API
      description: Collect the pins saved to Pinterest boards.
      operationId: socq_pinterest_board
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $schema: https://json-schema.org/draft/2020-12/schema
              type: object
              additionalProperties: false
              properties:
                callback_url:
                  type: string
                  format: uri
                results_limit:
                  type: integer
                  minimum: 1
                  maximum: 1000
                  default: 50
                urls:
                  type: array
                  items:
                    type: string
                    minLength: 1
                  minItems: 1
                  description: Public profile or content URLs.
              required:
                - urls
              description: >-
                Provide Pinterest board URLs in urls, using
                /{username}/{board}/. results_limit applies to each board,
                defaults to 50 and accepts integers from 1 to 1000. Pins come
                back in the order the board shows them.
      responses:
        '200':
          description: Task accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentSubmitResponse'
        '422':
          description: Input validation failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentValidationErrorResponse'
      security:
        - bearerAuth: []
        - apiKeyAuth: []
components:
  schemas:
    AgentSubmitResponse:
      type: object
      properties:
        code:
          type: integer
          const: 200
        data:
          type: object
          properties:
            task_id:
              type: string
            status:
              type: string
            created_time:
              type:
                - string
                - 'null'
          required:
            - task_id
            - status
    AgentValidationErrorResponse:
      type: object
      properties:
        code:
          type: integer
          const: 422
        error:
          type: object
          properties:
            message:
              type: string
            type:
              type: string
            details:
              type: object
          required:
            - message
            - type
      required:
        - code
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.