Get Pinboard

Retrieve a specific pinboard with all its pins.

Endpoint


GET /v1/pinboards/:boardId

Authentication

Requires API key with pinboards:read scope.

Example

Client-JS


import { PindownClient } from '@pindownai/client-js'
 
const client = new PindownClient({
  apiKey: process.env.PINDOWN_API_KEY
})
 
// Get pinboard
const pinboard = await client.pinboards.get('pb-abc123')
console.log(`Pinboard: ${pinboard.title}`)
console.log(`Pins: ${pinboard.pins.length}`)
console.log(`URL: ${pinboard.shareable_url}`)

cURL


curl -X GET https://api.pindown.ai/v1/pinboards/pb-abc123 \
  -H "Authorization: Bearer pk_live_your_api_key"

Node.js Fetch


const response = await fetch('https://api.pindown.ai/v1/pinboards/pb-abc123', {
  headers: {
    'Authorization': `Bearer ${process.env.PINDOWN_API_KEY}`
  }
})
 
const result = await response.json()
console.log(`Pinboard: ${result.data.title}`)

Response


{
  "success": true,
  "data": {
    "id": "pb-abc123",
    "title": "Sales Dashboard",
    "description": "Real-time sales metrics",
    "pins": [],
    "layout": {},
    "mobile_layout": null,
    "is_public": false,
    "created_at": 1730472600000,
    "updated_at": 1730472600000,
    "owner_id": "user123"
  }
}

Rate Limiting

This endpoint costs 1 token per request.