List Pinboards

Get all pinboards for the authenticated user.

Endpoint


GET /v1/pinboards

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
})
 
// List all pinboards
const pinboards = await client.pinboards.list()
console.log(`Total pinboards: ${pinboards.length}`)
 
pinboards.forEach(pb => {
  console.log(`- ${pb.title} (${pb.pins.length} pins)`)
})

cURL


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

Node.js Fetch


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

Response


{
  "success": true,
  "data": [
    {
      "id": "pb-abc123",
      "title": "Sales Dashboard",
      "pin_count": 5,
      "created_at": 1730472600000
    },
    {
      "id": "pb-xyz789",
      "title": "Marketing Board",
      "pin_count": 3,
      "created_at": 1730472500000
    }
  ]
}

Rate Limiting

This endpoint costs 1 token per request.