Skip to Content
Pindown.ai is in early alpha - features may change
Pages APIList Pins in Page

List Pins in Page

Get all pins in a specific page.

Endpoint

GET /v1/pages/:pageId/pins

Authentication

Requires API key with pages:read scope.

Authorization: Bearer pk_live_your_api_key

Path Parameters

ParameterTypeRequiredDescription
pageIdstringYesPage ID (e.g., pg-abc123)

Example

import { PindownClient } from '@pindownai/client-js'
 
const client = new PindownClient({
  apiKey: process.env.PINDOWN_API_KEY
})
 
const result = await client.pages.listPins('pg-abc123')
 
console.log(`Page has ${result.total} pins`)
result.pins.forEach(pinId => {
  console.log(`- Pin: ${pinId}`)
})

Response

{
  "success": true,
  "data": {
    "pins": [
      {
        "id": "p-pin1",
        "metadata": {
          "title": "Report Header",
          "pin_type": "markdown"
        }
      },
      {
        "id": "p-pin2",
        "metadata": {
          "title": "Key Metrics",
          "pin_type": "stat-cards"
        }
      }
    ],
    "total": 2
  }
}

Notes

  • Pins are returned in the order they appear on the page (top to bottom)
  • Each pin includes full metadata and configuration

Next Steps

Remove Pin from PageShare Page