A Pinterest post is pinned to a board, and a post set cannot be scheduled until every Pinterest post in it has one. When you create a post set with a PINTEREST post, its board field takes the board's id and name: a DRAFT saves without it, but scheduling the set with the board missing fails with post-set:invalid_posts and the error A board is required. This endpoint lists the boards you can choose from, read live from the Pinterest account connected to the social set.
Boards are read-only over the API: create and manage them in Pinterest.
List Pinterest boards
GET /v1/pinterest/boards
curl "https://app.pallyy.com/api/v1/pinterest/boards?socialSetId=SET_ID&size=50" \
-H "Authorization: Bearer pallyy_your_api_key"
| Parameter | Required | Meaning |
|---|---|---|
socialSetId | Yes | The social set whose Pinterest account to read boards from |
size | No | How many boards to return, between 1 and 100, default 25 |
page | No | Accepted for consistency with the other list endpoints and echoed back, but it does not move through the list, see below |
Returns the boards of the account connected to the set, in the order Pinterest returns them. The response uses the common pagination envelope:
{
"items": [
{
"id": "1234567890123456789",
"name": "Spring collection"
}
],
"page": 0,
"size": 50
}
Pinterest pages its boards with a cursor rather than a page index, so this endpoint always returns the first size boards of the account regardless of page. To see more boards, raise size up to 100; most accounts fit in a single request.
The social set must be yours or shared with you, and inside the key's restriction, or the request answers 404. A set with no Pinterest account connected, or whose connection Pinterest rejects (for example after the account was disconnected on Pinterest's side), answers 412: reconnect the account in Pallyy and retry.
The board object
| Field | Type | Meaning |
|---|---|---|
id | string | The board id on Pinterest, passed as board.id on a Pinterest post |
name | string | The board name, passed as board.name on a Pinterest post |
More in Endpoints
Questions about the API? Email us at hey@pallyy.com and we'll get back to you.