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

# Pinterest

> Pinterest provides read-only lookups for the account the user linked to Headless. OAuth must be configured with the `boards:read`, `pins:read`, and `user_accounts:read` scopes.

## Profile, boards, and Pins

The `.pin` group without text shows the linked profile; with text it searches. `profile`, `boards`, `pins`, `search`, and `pin` read resources available to the account of the invoking user. Lists and searches use provider cursors and controls that only the requester can use.

### `.pinterest profile`

```headless-command Syntax theme={null}
.pinterest profile
```

```headless-command Example theme={null}
.pin profile
```

### `.pinterest boards`

```headless-command Syntax theme={null}
.pinterest boards
```

```headless-command Example theme={null}
.pin boards
```

### `.pinterest pins`

```headless-command Syntax theme={null}
.pinterest pins
```

```headless-command Example theme={null}
.pin pins
```

### `.pinterest pin`

```headless-command Syntax theme={null}
.pinterest pin <pin_id>
```

```headless-command Example theme={null}
.pin pin 99360735500167749
```

## Search

Normal search looks up Pins authorized to the account, normalizes whitespace, and accepts 2–100 characters. Public Partner/global search switches endpoints only when access is approved and enabled in deployment; it still requires a linked account and is not a guaranteed public feature. Account pages may contain up to 25 records; Partner search returns up to 10.

### `.pinterest search`

```headless-command Syntax theme={null}
.pinterest search <query>
```

```headless-command Example theme={null}
.pin search landscape
```

### `/pinterest search`

```headless-command Syntax theme={null}
/pinterest search query:<query>
```

```headless-command Example theme={null}
/pinterest search query:landscape
```

## Disconnect and limits

`disconnect` deletes the local Pinterest credential associated with the user. The encrypted PostgreSQL token vault does not assume or confirm remote revocation. Pin inputs must be 5–30 digit numeric IDs or official Pinterest URLs. Pinterest Lens and scraping are unavailable.

### `.pinterest connect`

```headless-command Syntax theme={null}
.pinterest connect
```

```headless-command Example theme={null}
.pin connect
```

### `.pinterest disconnect`

```headless-command Syntax theme={null}
.pinterest disconnect
```

```headless-command Example theme={null}
.pin disconnect
```

## Steps

**1. Authorize your account**

Use `.pin connect` or `/pinterest connect` and grant only the scopes shown by OAuth.

**2. Search or browse**

Run `.pin <text>`, `.pin boards`, `.pin pins`, or `.pin v <ID|URL>`; results are limited to resources the API allows.

**3. Remove the credential**

Run `.pin disconnect`; this deletes the local token stored by Headless.

## Registered commands

* **`.pinterest [text]` (`.pin`)** — **Slash command:** — · **Result:** Without text shows your profile; with text searches accessible Pins. · **Prefix cooldown:** 6 s
* **`.pinterest profile` (`p`, `perfil`)** — **Slash command:** `/pinterest profile` · **Result:** Shows the linked Pinterest profile. · **Prefix cooldown:** 5 s
* **`.pinterest boards` (`b`, `tableros`)** — **Slash command:** `/pinterest boards` · **Result:** Lists authorized boards. · **Prefix cooldown:** 5 s
* **`.pinterest pins` (`list`, `mis-pins`)** — **Slash command:** `/pinterest pins` · **Result:** Lists authorized Pins. · **Prefix cooldown:** 5 s
* **`.pinterest search <text>` (`s`, `buscar`)** — **Slash command:** `/pinterest search query` · **Result:** Searches Pins visible to the authorized account. · **Prefix cooldown:** 6 s
* **`.pinterest pin <ID|URL>` (`get`, `view`, `v`, `detalle`)** — **Slash command:** `/pinterest pin pin_url_or_id` · **Result:** Shows a Pin readable by the linked account. · **Prefix cooldown:** 5 s
* **`.pinterest connect` (`conectar`)** — **Slash command:** `/pinterest connect` · **Result:** Opens the official flow to authorize your own account. · **Prefix cooldown:** 10 s
* **`.pinterest disconnect` (`desconectar`)** — **Slash command:** `/pinterest disconnect` · **Result:** Deletes the user's local Pinterest credential. · **Prefix cooldown:** 10 s

> [!WARNING]
>
> Do not assume a private Pin is readable. Deleting the local credential is not confirmed remote revocation; also manage provider authorization if you need to remove it completely.

**Note:**

The callbacks declare no elevated Discord permissions. Lookups use the invoking Discord user's ID; account-related slash responses are ephemeral.

## Related pages

* [Integrations](/docs/en/integrations.md)
* [TikTok](/docs/en/integrations/tiktok.md)
* [YouTube](/docs/en/integrations/youtube.md)
* [Dashboard](/docs/en/dashboard.md)


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