List Pages

List all pages for the authenticated user.

Endpoint


GET /v1/pages

Authentication

Requires API key with pages:read scope.


Authorization: Bearer pk_live_your_api_key

Query Parameters

Parameter	Type	Required	Description
`limit`	number	No	Maximum number of pages to return (default: 50, max: 100)
`offset`	number	No	Number of pages to skip (default: 0)

Example

Client-JS


import { PindownClient } from '@pindownai/client-js'
 
const client = new PindownClient({
  apiKey: process.env.PINDOWN_API_KEY
})
 
const result = await client.pages.list({
  limit: 20,
  offset: 0
})
 
console.log(`Found ${result.total} pages`)
result.pages.forEach(page => {
  console.log(`- ${page.metadata.title} (${page.pins.length} pins)`)
})

cURL


curl -X GET "https://api.pindown.ai/v1/pages?limit=20&offset=0" \
  -H "Authorization: Bearer pk_live_your_api_key"

Node.js Fetch


const response = await fetch('https://api.pindown.ai/v1/pages?limit=20&offset=0', {
  headers: {
    'Authorization': `Bearer ${process.env.PINDOWN_API_KEY}`
  }
})
 
const result = await response.json()
console.log(`Found ${result.data.total} pages`)

Response


{
  "success": true,
  "data": {
    "pages": [
      {
        "id": "pg-abc123",
        "metadata": {
          "title": "Monthly Sales Report",
          "tags": ["sales", "monthly"],
          "created_at": "2024-11-23T10:00:00Z"
        },
        "pins": ["p-pin1", "p-pin2"],
        "created_at": 1703123456789
      }
    ],
    "total": 1
  }
}

Next Steps

Get Page - Retrieve specific page
Create Page - Create a new page
List Shared Pages - Get pages shared with you