Skip to main content
Back to API docs

Pinterest board lookup

List Pinterest Board IDs for a Connected Account

Pinterest publishes every Pin to a board, so a publish request needs a board id. This page covers the endpoint that lists the boards for one connected Pinterest account using the X-API-Key header, what each field means, and how to use the board id in a publish call.

Endpoint

GET /api/content/pinterest/boards returns the boards for one connected Pinterest account. Pass the connected accountId as a query parameter and authenticate with the X-API-Key header (a Bearer token also works for dashboard sessions). The data array lists each board with the id to use when publishing.

const API_BASE_URL = 'https://api.wahdx.com';
const API_KEY = process.env.WAHDX_API_KEY;

const accountId = 'PINTEREST_ACCOUNT_ID';
const url = API_BASE_URL + '/api/content/pinterest/boards?accountId=' + encodeURIComponent(accountId);

const response = await fetch(url, {
  headers: { 'X-API-Key': API_KEY }
});
const { data: boards } = await response.json();
console.log(boards);

Response fields

Each item in data describes one board the account can publish to. Use id as pinterestSettings.board_id in the publish request.

Pinterest board fields
FieldMeaning
idBoard id to send as pinterestSettings.board_id
nameBoard name
urlPublic Pinterest board URL
privacyPUBLIC or SECRET

Using the board id

Take the id from this endpoint and send it as pinterestSettings.board_id in POST /api/content/post. A video Pin also needs pinterestSettings.cover_image_url. To publish to several Pinterest accounts, call this endpoint once per account; each account has its own boards.

POST /api/content/post
X-API-Key: <server-side key>
Content-Type: application/json

{
  "platform": "pinterest",
  "accountId": "PINTEREST_ACCOUNT_ID",
  "content": "Pin description up to 500 characters",
  "mediaItems": [{ "url": "https://your-domain.com/photo.jpg" }],
  "pinterestSettings": {
    "board_id": "BOARD_ID_FROM_THIS_ENDPOINT"
  }
}

Errors

The endpoint returns a specific status so an integration can react without guessing.

  • 400 when accountId is missing or the account is not a Pinterest account.
  • 404 when the accountId is not connected to your workspace.
  • 401 when the X-API-Key is missing or invalid.

FAQ

Common questions about this API topic.

Which header does this endpoint use?

Send your X-API-Key header, the same key the other content endpoints use. A Bearer token also works for dashboard sessions.

Why do I need the board id?

Every Pinterest Pin is published to a board, so the publish request needs pinterestSettings.board_id. This endpoint is how an API integration reads the available board ids.

Can I list boards for all my Pinterest accounts at once?

Call the endpoint once per accountId. Each connected Pinterest account has its own boards, and a board belongs to one account.

Does this work in sandbox?

Yes. The endpoint reads boards from the environment the account was connected in, so sandbox accounts list sandbox boards.