> ## 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 User Boards

> Get the boards of Pinterest profiles with pin and follower counts.

# Pinterest User Boards

List every public board on a Pinterest profile. Each board comes with its name, description, cover image, owner, creation date and counts for pins, followers, sections and collaborators. Boards show how a brand or creator organizes its ideas, which themes it invests in and which collections people actually follow, so this is the first call when you audit a competitor's Pinterest or shortlist creators by topic.

```json theme={"dark"}
{
  "urls": [
    "https://www.pinterest.com/marthastewart/"
  ],
  "results_limit": 25
}
```

Provide Pinterest profile URLs in urls, such as [https://www.pinterest.com/username/](https://www.pinterest.com/username/). results\_limit applies to each profile, defaults to 25 and accepts integers from 1 to 500. Each board 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 | URL of the board. |
| `published_at` | `string` | Yes | Time the board was created, in ISO 8601 format. |
| `collected_at` | `string` | No | Time SocQ collected or processed this result, in ISO 8601 format. |
| `name` | `string` | Yes | Name of the board. |
| `text` | `string` | Yes | Description of the board. |
| `author` | `object` | Yes | Account that owns the board. |
| `author.id` | `string` | Yes | Unique identifier of the board owner. |
| `author.username` | `string` | Yes | Public username or handle of the account. |
| `author.name` | `string` | Yes | Display name of the board owner. |
| `author.url` | `string` | Yes | Profile URL of the board owner. |
| `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. |
| `cover_url` | `string` | Yes | URL of the board's cover image. |
| `is_collaborative` | `boolean` | Yes | Whether other accounts can add pins to the board. |
| `metrics` | `object` | Yes | Size and audience of the board. |
| `metrics.pins_count` | `integer` | Yes | Number of pins saved to the board. |
| `metrics.followers_count` | `integer` | Yes | Number of users following the board. |
| `metrics.sections_count` | `integer` | Yes | Number of sections the board is split into. |
| `metrics.collaborators_count` | `integer` | Yes | Number of collaborators who can add pins. |

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-user-boards",
    "status": "succeeded",
    "public_id": "pinterest/user-boards",
    "result_count": 1,
    "credits_amount": 0.5,
    "results": {
      "limit": 50,
      "next_cursor": null,
      "has_more": false,
      "schema_id": "board",
      "schema_version": "1.0",
      "items": [
        {
          "id": "32088284784058747",
          "platform": "pinterest",
          "resource": "user-boards",
          "type": "board",
          "url": "https://www.pinterest.com/marthastewart/letscelebrate-pin-party/",
          "published_at": "2013-06-05T14:01:03Z",
          "collected_at": "2026-11-17T14:40:47.052902Z",
          "name": "#LetsCelebrate Pin Party",
          "text": "Repin your favorite party on this board with #LetsCelebrate in the caption for the chance to win one of 10 celebrations-in-a-box we're giving away. The blogger who is repinned the most will receive a feature on MarthaStewart.com and a $250 JCP gift card.",
          "author": {
            "id": "32088353503445352",
            "username": "marthastewart",
            "name": "Martha Stewart",
            "url": "https://www.pinterest.com/marthastewart/",
            "avatar_url": "https://i.pinimg.com/75x75_RS/c8/11/4c/c8114c783347e27daef00e5d4a6ac4f3.jpg",
            "is_verified": null,
            "is_private": null
          },
          "cover_url": "https://i.pinimg.com/474x/8a/7e/d0/8a7ed0d71f0e2437849563d27f22cc6b.jpg",
          "is_collaborative": true,
          "metrics": {
            "pins_count": 1153,
            "followers_count": 1507446,
            "sections_count": 0,
            "collaborators_count": 13
          }
        }
      ]
    }
  }
}
```


## OpenAPI

````yaml api-manual/agent-api/agent-api.json POST /v1/pinterest/user-boards
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/user-boards:
    post:
      tags:
        - pinterest
      summary: Pinterest User Boards API
      description: Collect the boards of Pinterest profiles.
      operationId: socq_pinterest_user_boards
      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: 500
                  default: 25
                urls:
                  type: array
                  items:
                    type: string
                    minLength: 1
                  minItems: 1
                  description: Public profile or content URLs.
              required:
                - urls
              description: >-
                Provide Pinterest profile URLs in urls, such as
                https://www.pinterest.com/username/. results_limit applies to
                each profile, defaults to 25 and accepts integers from 1 to 500.
      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.