Get Page

Retrieve a specific page by ID with all its pins.

Endpoint


GET /v1/pages/:pageId

Authentication

Requires API key with pages:read scope.


Authorization: Bearer pk_live_your_api_key

Path Parameters

Parameter	Type	Required	Description
`pageId`	string	Yes	Page ID (e.g., `pg-abc123`)

Example

Client-JS


import { PindownClient } from '@pindownai/client-js'
 
const client = new PindownClient({
  apiKey: process.env.PINDOWN_API_KEY
})
 
const page = await client.pages.get('pg-abc123')
 
console.log(`Title: ${page.metadata.title}`)
console.log(`Pins: ${page.pins.length}`)

cURL


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

Node.js Fetch


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

Response


{
  "success": true,
  "data": {
    "id": "pg-abc123",
    "owner_id": "user-xyz789",
    "is_public": false,
    "metadata": {
      "title": "Monthly Sales Report",
      "tags": ["sales", "monthly"],
      "created_at": "2024-11-23T10:00:00Z",
      "updated_at": "2024-11-23T10:00:00Z"
    },
    "pins": ["p-pin1", "p-pin2", "p-pin3"],
    "created_at": 1703123456789,
    "updated_at": 1703123456789
  }
}

Next Steps

Update Page - Modify page details
List Pins in Page - Get all pins in a page
Add Pin to Page - Add more pins